Skip to content

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

Open
wants to merge 7 commits into
base: docs/guide
Choose a base branch
from

Conversation

AbstractUmbra
Copy link
Contributor

Summary

This PR adds a section to the guide for Permissions and PermissionOverwrites

Checklist

  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • This PR fixes an issue.
  • This PR adds something new (e.g. new method or parameters).
  • This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • This PR is not a code change (e.g. documentation, README, ...)

@AbstractUmbra AbstractUmbra force-pushed the docs/permissions-guide branch from dff5225 to 85ac0d1 Compare March 6, 2022 01:26
@Rapptz Rapptz added the guide This relates to the discord.py guide label Mar 9, 2022
@Rapptz Rapptz mentioned this pull request Mar 12, 2022
23 tasks

.. 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:
Copy link
Contributor

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.

Copy link
Contributor Author

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)
Copy link
Contributor

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.

Copy link
Contributor Author

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.

@AbstractUmbra AbstractUmbra force-pushed the docs/permissions-guide branch from bcd33c9 to 7b5df4c Compare March 17, 2022 17:33
Copy link
Contributor

@ArjunSharda ArjunSharda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Accidental]

@casper-hansen
Copy link

Is it possible to add documentation for how to do this?
image

@Rapptz
Copy link
Owner

Rapptz commented Jul 9, 2022

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.

@casper-hansen

This comment was marked as off-topic.

@Rapptz
Copy link
Owner

Rapptz commented Jul 9, 2022

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.

Copy link
Contributor

@Rinume-chan Rinume-chan left a 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.

Copy link

@thomasemeryy thomasemeryy left a 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.

@AbstractUmbra AbstractUmbra force-pushed the docs/permissions-guide branch from 7b5df4c to 4301b49 Compare February 4, 2024 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
guide This relates to the discord.py guide
Projects
Development

Successfully merging this pull request may close these issues.

8 participants