Cross references by clot27 · Pull Request #3135 · python-telegram-bot/python-telegram-bot

clot27 · 2022-07-03T09:37:24Z

Supersedes #3134

harshil21

Nice work. Left some comments below. If it's not too much work, can you rebase your branch on the top of the doc-fixes branch? If done correctly, Github will only show your commits and remove the pool size commit.

telegram/_bot.py

telegram/_inline/inlinekeyboardbutton.py

telegram/ext/_callbackdatacache.py

clot27 · 2022-07-07T12:54:19Z

Nice work. Left some comments below. If it's not too much work, can you rebase your branch on the top of the doc-fixes branch? If done correctly, Github will only show your commits and remove the pool size commit.

Umm, harshil I dont know how to rebase branches 🤔 could you help me please?

Bibo-Joshi · 2022-07-07T21:24:24Z

this article should get you started :) if you need more help, please ping us in the dev-chat on tg

clot27 · 2022-07-08T13:56:51Z

Why the codacy test is failing?

Poolitzer · 2022-07-08T14:00:03Z

It cant find the git difference for some reason

harshil21

nice job rebasing, most of my comments is just now moving stuff above the Args section.

telegram/_bot.py

telegram/_inline/inlinekeyboardmarkup.py

telegram/_inline/inlinekeyboardbutton.py

telegram/_keyboardbuttonpolltype.py

telegram/_poll.py

telegram/ext/_jobqueue.py

telegram/ext/_pollhandler.py

telegram/ext/_pollanswerhandler.py

telegram/ext/_precheckoutqueryhandler.py

telegram/ext/_shippingqueryhandler.py

Bibo-Joshi

Hi. Sorry, I'm a bit late to the review-party … The additions are all nice 👍 I have three more general comments:

CallbackQuery has a bunch of shortcut methods as well, like edit_message_text. Can you check the documentation of that class and also link them in the Bot class?
the User class also has all the send_* shortcuts, like Chat does. please also link these :)
many .. seealso:: directives are in the wrong position in the docstring. The docstring should have the following order:
1. General description of the class/method
2. seealso (sometimes this can also be part of 1.)
3. .. versionadded::/.. versionchanged::
4. Arguments
5. Attributes/Returns
Please move your additions accordingly

I also saw a few added newlines, that we don't really need, but that's not overly important.

telegram/ext/_callbackdatacache.py

Bibo-Joshi

Thanks for the updates! I left a few nitpick-comments :) In additon, the shortcut methods {User, Chat}.get/set_menu_button can also be linked in Bot.{get, set}_chat_menu_button

Bibo-Joshi · 2022-07-17T11:16:06Z

telegram/_bot.py

            by Telegram.

+        .. seealso:: :attr:`telegram.Message.reply_animation`, :attr:`telegram.Chat.send_animation`
+


User.send_animation

Bibo-Joshi · 2022-07-17T11:18:07Z

telegram/_bot.py


+        .. seealso:: :attr:`telegram.Message.copy`, :attr:`telegram.Chat.send_copy`,
+            :attr:`telegram.Chat.copy_message`, :attr:`telegram.User.send_copy`
+


User.copy_message

Bibo-Joshi · 2022-07-17T11:24:55Z

telegram/ext/_contexttypes.py

+    .. seealso:: `contexttypesbot.py <https://github.com/python-telegram-bot/
+        python-telegram-bot/blob/master/examples/contexttypesbot.py>`_
+


Suggested change

.. seealso:: `contexttypesbot.py <https://github.com/python-telegram-bot/

python-telegram-bot/blob/master/examples/contexttypesbot.py>`_

.. seealso:: `contexttypesbot.py <examples.contexttypesbot.html>`_

the other links use this - I take it this was tested?

Bibo-Joshi · 2022-07-17T11:25:14Z

telegram/ext/_extbot.py

+    .. seealso:: `arbitrarycallbackbot.py <https://github.com/python-telegram-bot/
+        python-telegram-bot/blob/master/examples/arbitrarycallbackdatabot.py>`_,


Bibo-Joshi · 2022-07-17T11:25:22Z

telegram/ext/_inlinequeryhandler.py

          chats and may not be set for inline queries coming from third-party clients. These
          updates won't be handled, if :attr:`chat_types` is passed.

+    .. seealso:: `inlinebot.py <https://github.com/python-telegram-bot/


Bibo-Joshi · 2022-07-17T11:25:36Z

telegram/ext/_pollanswerhandler.py

        When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom
        attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info.

+    .. seealso:: `pollbot.py <https://github.com/python-telegram-bot/


Bibo-Joshi · 2022-07-17T11:25:41Z

telegram/ext/_pollhandler.py

        When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom
        attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info.

+    .. seealso:: `pollbot.py <https://github.com/python-telegram-bot/


Bibo-Joshi · 2022-07-20T20:05:45Z

Thank you very much for your contribution and the patience during the review process :)

lemontree210 · 2022-11-28T16:23:42Z

addresses #3110 (just adding for this PR to show up on the page of the issue)

clot27 added 5 commits July 3, 2022 10:56

added some corss references

4b7a2bc

added some cross references

90eb781

add some cross references

e425513

add more cross references

ed271c3

fix tests

d359fe8

harshil21 reviewed Jul 5, 2022

View reviewed changes

harshil21 added the ⚙️ documentation affected functionality: documentation label Jul 6, 2022

harshil21 added this to the v20.0a3 milestone Jul 6, 2022

add requested changes

de9901c

fix tests and add a missing reference

65ef2d3

fixing tests

09da7ba

harshil21 requested changes Jul 8, 2022

View reviewed changes

clot27 added 2 commits July 10, 2022 07:02

some more work

7e5b749

fix tests

a884354

harshil21 approved these changes Jul 10, 2022

View reviewed changes

Bibo-Joshi requested changes Jul 11, 2022

View reviewed changes

telegram/ext/_callbackdatacache.py Show resolved Hide resolved

clot27 added 2 commits July 14, 2022 21:37

add requested changes

14232f3

fix failing tests

2fa2cea

Bibo-Joshi requested changes Jul 17, 2022

View reviewed changes

add more requested changes

e9e743e

harshil21 changed the title ~~Crosss references~~ Cross references Jul 20, 2022

pre-commit

4ab6b6a

Bibo-Joshi merged commit 3d8dc4c into python-telegram-bot:doc-fixes Jul 20, 2022

Bibo-Joshi mentioned this pull request Jul 20, 2022

Documentation Improvements #3139

Merged

2 tasks

github-actions bot locked and limited conversation to collaborators Jul 28, 2022

		by Telegram.

		.. seealso:: :attr:`telegram.Message.reply_animation`, :attr:`telegram.Chat.send_animation`


		.. seealso:: :attr:`telegram.Message.copy`, :attr:`telegram.Chat.send_copy`,
		:attr:`telegram.Chat.copy_message`, :attr:`telegram.User.send_copy`

		.. seealso:: `contexttypesbot.py <https://github.com/python-telegram-bot/
		python-telegram-bot/blob/master/examples/contexttypesbot.py>`_

		.. seealso:: `arbitrarycallbackbot.py <https://github.com/python-telegram-bot/
		python-telegram-bot/blob/master/examples/arbitrarycallbackdatabot.py>`_,

Conversation

clot27 commented Jul 3, 2022

Uh oh!

harshil21 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clot27 commented Jul 7, 2022

Uh oh!

Bibo-Joshi commented Jul 7, 2022

Uh oh!

clot27 commented Jul 8, 2022

Uh oh!

Poolitzer commented Jul 8, 2022

Uh oh!

harshil21 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Bibo-Joshi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Bibo-Joshi left a comment

Choose a reason for hiding this comment

Uh oh!

Bibo-Joshi Jul 17, 2022

Choose a reason for hiding this comment

Uh oh!

Bibo-Joshi Jul 17, 2022

Choose a reason for hiding this comment

Uh oh!

Bibo-Joshi Jul 17, 2022 • edited by harshil21 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

harshil21 Jul 17, 2022

Choose a reason for hiding this comment

Uh oh!

Bibo-Joshi Jul 17, 2022

Choose a reason for hiding this comment

Uh oh!

Bibo-Joshi Jul 17, 2022

Choose a reason for hiding this comment

Uh oh!

Bibo-Joshi Jul 17, 2022

Choose a reason for hiding this comment

Uh oh!

Bibo-Joshi Jul 17, 2022

Choose a reason for hiding this comment

Uh oh!

Bibo-Joshi commented Jul 20, 2022

Uh oh!

lemontree210 commented Nov 28, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Bibo-Joshi Jul 17, 2022 •

edited by harshil21

Loading