Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation on axios-http.com is outdated #6398

Open
Steel-Shadow opened this issue May 17, 2024 · 4 comments
Open

Documentation on axios-http.com is outdated #6398

Steel-Shadow opened this issue May 17, 2024 · 4 comments

Comments

@Steel-Shadow
Copy link

Section/Content To Improve

Request Config documentation on axios-http.com is outdated.

Suggested Improvement

withXSRFToken is missing from the documentation above.
The README.md on the github repo is up to date. But the documentation on axios-http.com is not.

The following is in README.md but not on the documentation site.

 // `undefined` (default) - set XSRF header only for the same origin requests
  withXSRFToken: boolean | undefined | ((config: InternalAxiosRequestConfig) => boolean | undefined),

The website should be updated in time.

Relevant File(s)

No response

@sixmachine-6
Copy link

i will try

@jasonsaayman
Copy link
Member

yeah i think it may be time to make a change to that.... i think the docs not living next to the code really makes it a chore for contributors to work on the docs... i will have a look at improving here and making things better

@sixmachine-6
Copy link

how should i approach sir...

@jasonsaayman
Copy link
Member

you dont need to, i am half way through making new docs and I will then add them to the repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants