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

Skip to content

Docs fix/add introductory paragraphs to subsections #4389

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

Merged
merged 27 commits into from
Jul 24, 2024
Merged

Docs fix/add introductory paragraphs to subsections #4389

merged 27 commits into from
Jul 24, 2024

Conversation

mohdyusuf2312
Copy link
Contributor

Description

This pull request adds introductory paragraphs to several sections in the PTB documentation and updates the "More info on xy" links to point to the PTB docs where appropriate.

Changes Made

  • Added introductory paragraphs to the Payments, Passport, Games, Inline Mode, Stickers, and Available Types sections.
  • Updated "More info on xy" links to point to relevant sections in the PTB docs.
  • Added my name to the AUTHORS.rst file.

Issue Addressed

docs/fix #4380

Available Types section before

image

Available Types section after

image

Stickers section before

image

Stickers section after

image

Inline Mode section before

image

Inline Mode section after

image

Payment section before

image

Payment section after

image

Games section before

image

Games section after

image

Passport section before

image

Passport section after

image

Additional Information

Please review the changes and let me know if any further adjustments are needed.

@Poolitzer
Copy link
Member

Hello, thanks for the PR.

Please dont modify the gitignore. The available types change is not needed, neither do we provide json objects nor does python have 32 bit signed integers.

For the rest without looking deeply into it: Please use for linking to ours the internal links as we do in the docs. So e.g. paramref:~telegram.Bot.local_mode for a parameter, :attr:telegram.Message.reply_markup for an attribute, :meth:telegram.Bot.set_game_score for a method, etc.

@mohdyusuf2312
Copy link
Contributor Author

image

I'm trying to apply internal linking, but it is not clickable. Can you please suggest how I can resolve this?

@Bibo-Joshi
Copy link
Member

Hi. the linking is case sensitive, i.e. :class:`telegram.Game` can work, but :class:`Telegram.Game` can not. If you want to link to a headline, it should be possible to use the headline as lower case and "-" instead of " " as target - e.g. :ref:`inline-mode` for a headline "Inline Mode". I'm not 100% sure on this one though.
Additionally, when you build the documentation in the command line, you will see warnings and errors being printed for references that could not be resolved.
If you're new to documentation python code with Sphinx, please also have a look at their documentation, especiall at the rst primer and the referencing syntax.

@mohdyusuf2312
Copy link
Contributor Author

If you're new to documentation python code with Sphinx, please also have a look at their documentation, especiall at the rst primer and the referencing syntax.
Thanks @Bibo-Joshi Sir

Copy link
Member

@Bibo-Joshi Bibo-Joshi 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 updates. I left a few comments. In addition, what's still missing is making the "more about" links ponit to the PTB docs rather than TG docs as explained in #4380, e.g.

`More about games >> <https://core.telegram.org/bots/api#games>`_.

@mohdyusuf2312
Copy link
Contributor Author

Hello, is everything done, or should I do anything else?

@mohdyusuf2312 mohdyusuf2312 requested a review from Bibo-Joshi July 22, 2024 12:34
@mohdyusuf2312 mohdyusuf2312 requested a review from Bibo-Joshi July 23, 2024 06:48
Copy link
Member

@Bibo-Joshi Bibo-Joshi left a comment

Choose a reason for hiding this comment

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

Added two small fixes that are not you're fault (see tdlib/telegram-bot-api#617).
LGTM now. Thanks very much for the PR and your patience during the review process :)

@Bibo-Joshi Bibo-Joshi merged commit 8a205b1 into python-telegram-bot:master Jul 24, 2024
25 checks passed
@mohdyusuf2312 mohdyusuf2312 deleted the docs-fix/add-introductory-paragraphs-to-subsections branch July 25, 2024 06:01
@mohdyusuf2312
Copy link
Contributor Author

Thank you sir, I feel very happy to complete my first contribution to open source. :)

@github-actions github-actions bot locked and limited conversation to collaborators Aug 2, 2024
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.

[Docs] Include introductory pragraphs
3 participants