Class docstrings aligned with API and format unified - #2621
Conversation
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
@coder2020official ONLY docstrings here, no parameters update itself YET )
|
ReplyKeyboardMarkup - keyboard added InlineKeyboardMarkup - keyboard changed to inline_keyboard. Poll - poll_id changed to id
| :param supergroup_chat_created: Optional. Service message: the supergroup has been created. This field can't be | ||
| received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can | ||
| only be found in reply_to_message if someone replies to a very first message in a directly created supergroup. | ||
| :param supergroup_chat_created: Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup. |
There was a problem hiding this comment.
I'd rather break long descriptions down into multiple lines
There was a problem hiding this comment.
I'd rather break long descriptions down into multiple lines
I did this for two reasons.
1 - Docstrings are used for manuals and hints. Both align long strings like this:
Inside library code nobody read them. So there is no need to place long stings into multiple strings manually.
2 - Multilne descriptions are very hard to verify/align automatically due to hard structure of the API/classes.
There was a problem hiding this comment.
Uhh idk it just looks nicer on the inside. I must've done it for a reason. maybe it was because I kept getting warnings when I generated docs? (pytba.readthedocs.io/en/latest/)
There was a problem hiding this comment.
Uhh idk it just looks nicer on the inside. I must've done it for a reason. maybe it was because I kept getting warnings when I generated docs? (pytba.readthedocs.io/en/latest/)
Looks also fine, isn't it?
There was a problem hiding this comment.
It'll look fine just billions of warnings when building docs... Are you sure you can't split descriptions into multiple lines?
There was a problem hiding this comment.
To be honest, docs warning looks like a quite weak reason for multilining descriptions...
|
Most of these docstrings were automatically generated back in 2023? |
What that means? All texts are aligned with the current API docs. |
|
Next update will be soon - lot of (~150) parameters descriptions will be automatically updated to current API. |
That's what is the main target for previous alignment ) |
|
@coder2020official I'm done here. |
|
@coder2020official Thank you. I see you do not like it too much, thus thank you twice. |
Description
Class docstrings aligned with API and format unified.
Some classes adopted to API signatures.