Fix docstring Args entries that name a parameter the class does not take - #5326
Open
darkdi wants to merge 3 commits into
Open
Fix docstring Args entries that name a parameter the class does not take#5326darkdi wants to merge 3 commits into
darkdi wants to merge 3 commits into
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Six Args: entries name something the callable does not take.
Four are the PaidMedia subclasses. Each documents type under Args:, but none of their __init__ takes it: super().__init__(type=PaidMedia.PREVIEW) and so on. MessageOrigin* is built exactly the same way and documents type only under Attributes:, which is what made me read these as a slip rather than a house style. The Attributes: entry stays in all four.
decrypt documents a file argument it does not have, and ApplicationBuilder.get_updates_proxy documents proxy, copied from the proxy method above it. That one had to be rewrapped to stay under 99 characters.
ruff check and ruff format --check are clean on the three files with the pinned ruff==0.16.0. If the type entries are deliberate I will drop that part of the change.