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

docs: add note about idempotence to role add/remove routes #10586

Merged
merged 2 commits into from
Nov 5, 2024

Conversation

almostSouji
Copy link
Member

Please describe the changes this PR makes and why it should be merged:

It's not clear to users that the behaviour of #add and #remove calls changes based on if a singular or multiple roles are supplied. We should explicitly note that, as it can lead to issues (for example when multiple role-state bots interact and use patch calls).

Status and versioning classification:

  • Code changes have been tested against the Discord API, or there are no code changes
  • I know how to update typings and have done so, or typings don't need updating
  • This PR only includes non-code changes, like changes to documentation, README, etc.

@almostSouji almostSouji requested a review from a team as a code owner November 1, 2024 13:45
Copy link

vercel bot commented Nov 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
discord-js ⬜️ Ignored (Inspect) Visit Preview Nov 5, 2024 8:50am
discord-js-guide ⬜️ Ignored (Inspect) Visit Preview Nov 5, 2024 8:50am

@almeidx almeidx changed the title chore(docs): Add note about idempotence to role add/remove routes docs: add note about idempotence to role add/remove routes Nov 1, 2024
@almostSouji almostSouji force-pushed the docs-role-idempotence branch from 23130bc to 12e169f Compare November 5, 2024 08:50
@kodiakhq kodiakhq bot merged commit f02bdc3 into main Nov 5, 2024
8 checks passed
@kodiakhq kodiakhq bot deleted the docs-role-idempotence branch November 5, 2024 09:29
Jiralite pushed a commit that referenced this pull request Nov 5, 2024
* chore(docs): Add note about idempotence to role add/remove routes

* chore: remove trailing spaces
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants