Skip to content
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

Merged

Conversation

simonfongnt
Copy link
Contributor

@simonfongnt simonfongnt commented Aug 30, 2022

Refer to #3109, List args docstrings and attributes docstrings are unified, and the lines are limited to their maximum length.

Checklist for PRs

  • Added .. versionadded:: version, .. versionchanged:: version or .. deprecated:: version to the docstrings for user facing changes (for methods/class descriptions, arguments and attributes)
  • Created new or adapted existing unit tests
  • Documented code changes according to the CSI standard
  • Added myself alphabetically to AUTHORS.rst (optional)
  • Added new classes & modules to the docs and all suitable __all__ s

@Poolitzer Poolitzer changed the title unify args and attributes docstrings unify args and attributes docstrings in Message class Aug 30, 2022
Copy link
Member

@harshil21 harshil21 left a 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!

telegram/_message.py Outdated Show resolved Hide resolved
telegram/_message.py Outdated Show resolved Hide resolved
telegram/_message.py Outdated Show resolved Hide resolved
telegram/_message.py Outdated Show resolved Hide resolved
telegram/_message.py Outdated Show resolved Hide resolved
telegram/_message.py Outdated Show resolved Hide resolved
telegram/_message.py Outdated Show resolved Hide resolved
simonfongnt and others added 2 commits August 31, 2022 01:13
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
@simonfongnt
Copy link
Contributor Author

simonfongnt commented Aug 30, 2022

The first patch further unified the docstrings upon the suggestions, and cleared white-spaces.

Copy link
Member

@harshil21 harshil21 left a 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

@Bibo-Joshi
Copy link
Member

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 :)

Copy link
Member

@harshil21 harshil21 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

last nitpick

telegram/_message.py Outdated Show resolved Hide resolved
simonfongnt and others added 2 commits September 1, 2022 06:06
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
2 more extra spaces are found upon suggestions.
@simonfongnt
Copy link
Contributor Author

The second patch also removes extra spaces in other 2 places. Hopefully, these should be all.

@harshil21
Copy link
Member

Thanks for the changes!

@harshil21 harshil21 merged commit 83c073f into python-telegram-bot:doc-fixes Sep 1, 2022
@simonfongnt simonfongnt deleted the message-docstrings branch September 1, 2022 14:38
@github-actions github-actions bot locked and limited conversation to collaborators Sep 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants