Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Missing a part of the documentation #4764

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

Closed
elebur opened this issue Apr 20, 2025 · 1 comment
Closed

Missing a part of the documentation #4764

elebur opened this issue Apr 20, 2025 · 1 comment
Labels
📋 invalid work status: invalid

Comments

@elebur
Copy link

elebur commented Apr 20, 2025

Steps to Reproduce

The source code and the rendered documenation for the Bot.delete_message are different.

Expected behaviour

The documentation is the same.

Actual behaviour

The rendered one is missing this part:

The method CallbackQuery.delete_message() will not be found when automatically
generating "Shortcuts" admonitions for Bot methods because it has no calls
to Bot methods in its return statement(s). So it is manually included in "See also".

Perhaps other methods are affected too.

Operating System

None

Version of Python, python-telegram-bot & dependencies

python-telegram-bot 22.0
Bot API 8.3
Python 3.9.22 (main, Apr  9 2025, 08:54:15)  [GCC 13.3.0]

Relevant log output

Additional Context

No response

@elebur elebur added the 📋 triage work status: triage label Apr 20, 2025
@Bibo-Joshi
Copy link
Member

Hi. That's right and intended. the .. in line 1140 indicatest that this is a rst comment, see e.g. https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#comments :)

@Bibo-Joshi Bibo-Joshi closed this as not planned Won't fix, can't repro, duplicate, stale Apr 20, 2025
@Bibo-Joshi Bibo-Joshi added 📋 invalid work status: invalid and removed 📋 triage work status: triage labels Apr 20, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Apr 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📋 invalid work status: invalid
Projects
None yet
Development

No branches or pull requests

2 participants