-
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Permissions guide #7497
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
base: docs/guide
Are you sure you want to change the base?
Permissions guide #7497
Conversation
dff5225
to
85ac0d1
Compare
docs/guide/topics/permissions.rst
Outdated
|
||
.. code-block:: python3 | ||
|
||
# I have found that the easiest way to do this, is to get the current overwrites for the Role or Member we're editing: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it the easiest way? This is kind of a rhetorical question, but I feel like we should be confident about what we're putting into a guide. After all, the reader is trusting that the information we've taken time to accumulate is our best-in-class "seal of approval" technique.
We can deliberate as much as we want while writing it, and leave only the information we know is tried and true in the document. There's no reason to clue the reader in on this process, the work should already be done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Valid point, for now I have made this
# One of the easiest ways to do this, ...
I will however leave this conversation open and ask for further feedback from other docs contributors.
overwrites[member] = member_overwrite | ||
|
||
# and edit the channel with them: | ||
await channel.edit(overwrites=overwrites) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I discussed this on other guide reviews, but I think it is always best practice to end a guide with prose as opposed to a codeblock/warning/other directive, because it makes the document feel better rounded off.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do agree, but I am not sure what to add here personally. Similar to the other remaining conversation I will await feedback from other contributors.
bcd33c9
to
7b5df4c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Accidental]
It's not possible to do that without OAuth2, which is outside of the scope of the library. Only administrators of the server are allowed to modify those permissions. What you can do however, is set the default permissions of a command. |
This comment was marked as off-topic.
This comment was marked as off-topic.
The documentation for it resides here. Though this is off-topic to this PR. Consider joining the discord.py server instead of asking questions here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall pretty good, just a few mistakes and nit picks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some very minor changes regarding typos, capitalisation and wording. Sorry in advance about how many suggestions there are, and feel free to ignore anything I say. Other than that, looks very good.
7b5df4c
to
4301b49
Compare
Summary
This PR adds a section to the guide for Permissions and PermissionOverwrites
Checklist