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: clarify which checks GuildMember#manageable does #3870

Merged
merged 1 commit into from Mar 1, 2020

Conversation

@almostSouji
Copy link
Member

almostSouji commented Mar 1, 2020

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

After a users confusion we discussed on the server about how we could be more semantic on what GuildMember#manageable does internally and what it is used for:

  • Check for role hierarchy
  • Guild ownership overrides (from either side)
  • The client user can not manage itself
  • basis for moderative actions

This PR is the conclusion of this conversation and proposes its outcome:

Whether the client user is above this user in the hierarchy, according to role position and guild ownership.
This is a prerequisite for many moderative actions.

Status

  • 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

Semantic versioning classification:

  • This PR changes the library's interface (methods or parameters added)
    • This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
  • This PR only includes non-code changes, like changes to documentation, README, etc.
@jennasisis

This comment has been minimized.

Copy link

jennasisis commented Mar 1, 2020

Possible change: Uses of the word user should be changed to member to keep consistent with the differences between user and member in the library

@almostSouji

This comment has been minimized.

Copy link
Member Author

almostSouji commented Mar 1, 2020

The "client user" is a set term for the currently logged in user - aka the bot.
Semantically a GuildMember is nothing but server associated data for a user, user being both the human or application connected to the Discord account (which is the meaning here) as well as the Discord entity User, a term for the service-wide information bound to a user or application.

@iCrawl
iCrawl approved these changes Mar 1, 2020
@iCrawl iCrawl merged commit 2d67fbb into discordjs:master Mar 1, 2020
3 checks passed
3 checks passed
ESLint
Details
TSLint
Details
Documentation
Details
@almostSouji almostSouji deleted the almostSouji:docs-manageable branch Mar 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.