docs: Add type for icon property of guild #2137
Conversation
Signed-off-by: Blue-Robin-Taken <[email protected]>
Blue-Robin-Taken
changed the title
| @@ -949,7 +949,7 @@ def owner(self) -> Member | None: | |||
|
|
|||
| @property | |||
| def icon(self) -> Asset | None: | |||
| """Returns the guild's icon asset, if available.""" | |||
| """Returns the guild's icon asset of type :class:`asset.Asset`, if available.""" | |||
There was a problem hiding this comment.
Can this not use the rtype directive?
https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html#the-sphinx-docstring-format
There was a problem hiding this comment.
Something like :class:~discord.Asset should work fine. But I can't see any place in the PyCord docs where poperty return types are mentioned in the docstring.
There was a problem hiding this comment.
There was a problem hiding this comment.
Wouldn't it be :type:
There was a problem hiding this comment.
No, :type: isn't a thing by default, and types are mostly classes ^^
There was a problem hiding this comment.
:type <param>: directive is to specify the type of a parameter. :rtype is to specify the return type.
See this https://www.sphinx-doc.org/en/master/tutorial/describing-code.html#documenting-python-objects
JustaSqu1d
requested review from
JustaSqu1d
and removed request for
CodeWithSwastik,
mccoderpy and
OmLanke
See #2141 |
|
Please add a changelog entry |
Summary
When I used this property, it took me a bit of time to find it's type. So, I believe it would be good to add it in the documentation.
Information
examples, ...).
Checklist
type: ignorecomments were used, a comment is also left explaining why.