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

Refactor type annotations and documentation #37

Merged
merged 10 commits into from
Apr 18, 2022

Conversation

DenverCoder1
Copy link
Collaborator

@DenverCoder1 DenverCoder1 commented Mar 10, 2022

Changes

  1. Fixed rst List documentation from :class:`List[nextcord.Embed]` to List[:class:`nextcord.Embed`] for proper linking.
  2. Documented the type of page in ListPageSource.format_page and AsyncIteratorPageSource.format_page
  3. Renamed _GroupByEntry named tuple to GroupByEntry and documented the class.
  4. Change type of SendKwargsType to allow any type to appear in the send kwargs returned by format_page. This includes files, stickers, bool, AllowedMentions, etc. to be passed in the kwargs dict.

Copy link
Contributor

@Skelmis Skelmis left a comment

Choose a reason for hiding this comment

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

Lgtm

@DenverCoder1 DenverCoder1 merged commit 21131e3 into nextcord:master Apr 18, 2022
@DenverCoder1 DenverCoder1 deleted the refactor branch April 18, 2022 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants