Add detailed docstrings for row and width properties in the Item class #10057
Conversation
This file contains 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
Commit was changed to original should not be in PR at all.
owocado
suggested changes
Jan 10, 2025
| @@ -113,6 +123,16 @@ def row(self, value: Optional[int]) -> None: | |||
|
|
|||
| @property | |||
| def width(self) -> int: | |||
| """int: The width of this item in a Discord UI layout. | |||
There was a problem hiding this comment.
Suggested change
| """int: The width of this item in a Discord UI layout. | |
| """:class:`int`: Returns the width of this item in a Discord UI layout. |
| @@ -100,6 +100,16 @@ def __repr__(self) -> str: | |||
|
|
|||
| @property | |||
| def row(self) -> Optional[int]: | |||
| """Optional[:class:`int`]: The action row this item belongs to. | |||
There was a problem hiding this comment.
Suggested change
| """Optional[:class:`int`]: The action row this item belongs to. | |
| """Optional[:class:`int`]: Returns the action row this item belongs to. |
There was a problem hiding this comment.
Suggested change
| """Optional[:class:`int`]: The action row this item belongs to. | |
| """Optional[:class:`int`]: Returns the row this item belongs to. |
DA-344
reviewed
Jan 14, 2025
Comment on lines
+131
to
+134
| Returns | ||
| ------- | ||
| :class:`int` | ||
| The width of the item, defaulting to 1. |
There was a problem hiding this comment.
Suggested change
| Returns | |
| ------- | |
| :class:`int` | |
| The width of the item, defaulting to 1. |
Properties don't have this Return, as their return type are stated above.
Comment on lines
+105
to
+106
| An action row can have up to 5 components. Valid values for the row are | ||
| integers in the range 0–4 or ``None`` to indicate no specific row. |
There was a problem hiding this comment.
Suggested change
| An action row can have up to 5 components. Valid values for the row are | |
| integers in the range 0–4 or ``None`` to indicate no specific row. |
This is already documented on the row parameter on each different Item subclass, so it is not needed.
| @@ -100,6 +100,16 @@ def __repr__(self) -> str: | |||
|
|
|||
| @property | |||
| def row(self) -> Optional[int]: | |||
| """Optional[:class:`int`]: The action row this item belongs to. | |||
There was a problem hiding this comment.
Suggested change
| """Optional[:class:`int`]: The action row this item belongs to. | |
| """Optional[:class:`int`]: Returns the row this item belongs to. |
| """int: The width of this item in a Discord UI layout. | ||
|
|
||
| The width determines how much space this item occupies in an action row. | ||
| This value is primarily used internally by Discord.py to calculate layout constraints. |
There was a problem hiding this comment.
I don't think mentioning this is necessary?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This pull request adds detailed docstrings to the
rowandwidthproperties of theItemclass in the Discord.py library. These docstrings provide clear explanations of their purpose, valid values, constraints, and usage within the framework, improving overall code clarity and documentation.Checklist