Documentation standardising #2348
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
novanai
commented
May 3, 2025
|
|
||
| @abc.abstractmethod | ||
| def get_members_view_for_guild( | ||
| self, guild_id: snowflakes.Snowflakeish, / |
Contributor
Author
There was a problem hiding this comment.
Why does this use guild_id instead of guild?
Member
There was a problem hiding this comment.
because it only takes Snowflakeish not SnowflakeishOr
Should be changed to guild: snowflakes.SnowflakeishOr[guilds.PartialGuild] imo
would need deprecation tho
Contributor
Author
There was a problem hiding this comment.
That's what I was thinking
davfsa
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
An attempt at standardising the format of all docstrings
Checklist
noxand all the pipelines have passed.I have made unittests according to the code I have added/modified/deleted.Related issues
N/A