Skip to content

Move examples in docstrings to separate blocks#3326

Merged
harshil21 merged 8 commits into
python-telegram-bot:doc-fixesfrom
lemontree210:blocks-with-examples-in-docstrings-3320
Nov 5, 2022
Merged

Move examples in docstrings to separate blocks#3326
harshil21 merged 8 commits into
python-telegram-bot:doc-fixesfrom
lemontree210:blocks-with-examples-in-docstrings-3320

Conversation

@lemontree210

Copy link
Copy Markdown
Member

closes #3320

pre-commit hooks don't pass because of cyclic import in _pollanswerhandler.py.

closes #3320

pre-commit hooks don't pass because of cyclic import
in _pollanswerhandler.py
closes #3320

The word "Example" for each example bot
doesn't seem to be necessary because there is now
a separate block for examples

pre-commit hooks don't pass because of cyclic import
in _pollanswerhandler.py
closes #3320

left a couple from previous commit
Comment thread telegram/_replykeyboardmarkup.py
Comment thread telegram/ext/_application.py
@lemontree210 lemontree210 changed the title Blocks with examples in docstrings 3320 Move examples in docstrings to separate blocks Nov 1, 2022

@harshil21 harshil21 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

very well done with the PR, thank you! The comments below are just for consistency, otherwise a great job.

Comment thread telegram/_payment/labeledprice.py Outdated
Comment thread telegram/_poll.py Outdated
Comment thread telegram/_payment/shippingoption.py Outdated
Comment thread telegram/_keyboardbuttonpolltype.py Outdated
Comment thread telegram/_webappdata.py Outdated
Comment thread telegram/ext/_jobqueue.py Outdated
Comment thread telegram/ext/_pollanswerhandler.py Outdated
Comment thread telegram/ext/_pollhandler.py Outdated
Comment thread telegram/ext/_precheckoutqueryhandler.py Outdated
Comment thread telegram/ext/_shippingqueryhandler.py Outdated
@harshil21 harshil21 added this to the v20.0b0 milestone Nov 1, 2022
@harshil21 harshil21 added the ⚙️ documentation affected functionality: documentation label Nov 1, 2022

@harshil21 harshil21 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM!

@harshil21 harshil21 merged commit 1cf931d into python-telegram-bot:doc-fixes Nov 5, 2022
@Bibo-Joshi Bibo-Joshi mentioned this pull request Nov 7, 2022
11 tasks
@github-actions github-actions Bot locked and limited conversation to collaborators Nov 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

⚙️ documentation affected functionality: documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants