New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
unify args and attributes docstrings in Message class #3217
unify args and attributes docstrings in Message class #3217
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR!
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
The first patch further unified the docstrings upon the suggestions, and cleared white-spaces. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work! Thank you! Deepsource failures are unrelated to this PR. Let's wait a bit longer in case other devs want to review
Harshil is the authorothy on docstrings IMO :D so I'm good. codacy is just a setting thing, we can ignore that. @harshil21 IMO you can merge at will :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
last nitpick
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
2 more extra spaces are found upon suggestions.
The second patch also removes extra spaces in other 2 places. Hopefully, these should be all. |
Thanks for the changes! |
Refer to #3109,
List
args docstrings and attributes docstrings are unified, and the lines are limited to their maximum length.Checklist for PRs
.. versionadded:: version
,.. versionchanged:: version
or.. deprecated:: version
to the docstrings for user facing changes (for methods/class descriptions, arguments and attributes)AUTHORS.rst
(optional)__all__
s