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

Unnecessarily confusing documentation with /post #4850

Open
danskal opened this issue Feb 11, 2025 · 0 comments
Open

Unnecessarily confusing documentation with /post #4850

danskal opened this issue Feb 11, 2025 · 0 comments
Labels

Comments

@danskal
Copy link

danskal commented Feb 11, 2025

This documentation:
https://redux-toolkit.js.org/rtk-query/usage-with-typescript
contains examples with endpoints called /post, and has Post scattered everywhere in the code. Any reader wanting to use HTTP POST ends up totally confused, and there's no need for it. It would be much better with /foo or /message or /wombat or anything that makes it clear that this is my part of the code, rather than something that RTK needs to be a certain way.

Following this principle (ie. make it very clear what is custom code and what is boilerplate) would ease adoption markedly, as noobs like myself find it really hard to tell what is boilerplate and what is custom code.

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

No branches or pull requests

2 participants