Skip to content

Conversation

@benwoo1110
Copy link
Contributor

About this pull request

Fix some docs and types typo related to the permissions PR.

Checklist

  • I've checked this pull request runs on Python 3.6.X.
  • This fixes something in Issues.
    • Issue:
  • This adds something new.
  • There is/are breaking change(s).
  • (If required) Relevant documentation has been updated/added.
  • This is not a code change. (README, docs, etc.)

@quirky-bluejay
Copy link
Contributor

Something i was thinking about. Would it be a good idea to document the format of permissions for the command decorators?
It's mostly mentioned in getting started, but imo you shouldn't have to look in guides to find that out.

@benwoo1110
Copy link
Contributor Author

benwoo1110 commented May 13, 2021

Yea the example code should be quite clear that it's a dictionary. Also I improved the docs string for them in the above commit.

Also there is a sentence on it in getting started:

The key being the guild to apply permissions on, and value being the list of permissions to apply.

@quirky-bluejay quirky-bluejay added the documentation Improvements or additions to documentation label May 13, 2021
Copy link
Contributor

@eunwoo1104 eunwoo1104 left a comment

Choose a reason for hiding this comment

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

LGTM

@eunwoo1104
Copy link
Contributor

Merging, thank you for contributing!

@eunwoo1104 eunwoo1104 merged commit ee983e6 into interactions-py:master May 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants