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

Unifying the docs for the Poll class. #3312

Merged
merged 11 commits into from Oct 27, 2022
Merged

Unifying the docs for the Poll class. #3312

merged 11 commits into from Oct 27, 2022

Conversation

RobiMez
Copy link
Contributor

@RobiMez RobiMez commented Oct 26, 2022

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

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, left some comments below

telegram/_bot.py Outdated Show resolved Hide resolved
telegram/_poll.py Outdated Show resolved Hide resolved
telegram/_poll.py Outdated Show resolved Hide resolved
telegram/_poll.py Outdated Show resolved Hide resolved
@harshil21 harshil21 added this to the v20.0b1 milestone Oct 26, 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.

2 more missed ones-

telegram/_poll.py Outdated Show resolved Hide resolved
telegram/_poll.py Outdated Show resolved Hide resolved
telegram/_poll.py Outdated Show resolved Hide resolved
RobiMez and others added 4 commits October 26, 2022 23:59
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
@harshil21
Copy link
Member

pre-commit is failing since the line is too long (L129 & 154 in _poll.py). It should be < 100 chars

@RobiMez
Copy link
Contributor Author

RobiMez commented Oct 26, 2022

ill add some breaks

@RobiMez
Copy link
Contributor Author

RobiMez commented Oct 26, 2022

done , also a few questions , was the line feed bit unnecessary ? is it because its a niche thing that people don't run into or it just didnt belong there ?

@RobiMez
Copy link
Contributor Author

RobiMez commented Oct 26, 2022

oh wait , trailing whitespace

@harshil21
Copy link
Member

@RobiMez it's the latter, the official documentation of Poll doesn't list that, so we don't write it.

@RobiMez
Copy link
Contributor Author

RobiMez commented Oct 26, 2022

@harshil21 Ohhh , makes sense , getting the hang of sphinx and your linting checks too. Ill tackle another class tomorrow as its getting late here. any priorities / which one needs most work ?

@harshil21
Copy link
Member

@harshil21 any priorities / which one needs most work?

no priorities as of now, feel free to dive in the code and pick any class(es) you find which has a large discrepancy. Try to do multiple classes together so as to not produce many PRs for the same thing.

@harshil21 harshil21 merged commit d93e6dc into python-telegram-bot:doc-fixes Oct 27, 2022
@harshil21 harshil21 mentioned this pull request Oct 30, 2022
11 tasks
@harshil21 harshil21 added the hacktoberfest-accepted Label PRs with this so that Hacktoberfest counts them as valid label Oct 31, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Nov 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation hacktoberfest-accepted Label PRs with this so that Hacktoberfest counts them as valid
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants