Doc fixes (#1499)

CHANGES.rst

@@ -86,7 +86,7 @@ Bug fixes & improvements
 - Allow SOCKSConnection to parse username and password from URL (`#1211`_)
 - Fix for arguments in passport/data.py (`#1213`_)
 - Improve message entity parsing by adding text_mention (`#1206`_)
-- Documentation fixes (`#1348`_, `#1397_`, `#1436`_)
+- Documentation fixes (`#1348`_, `#1397`_, `#1436`_)
 - Merged filters short-circuit (`#1350`_)
 - Fix webhook listen with tornado (`#1383`_)
 - Call task_done() on update queue after update processing finished (`#1428`_)
@@ -101,7 +101,7 @@ Buf fixes since v12.0.0b1
 - Fix _trigger_timeout() missing 1 required positional argument: 'job' (`#1367`_)
 - Add missing message.text check in PrefixHandler check_update (`#1375`_)
 - Make updates persist even on DispatcherHandlerStop (`#1463`_)
-- Dispatcher force updating persistence object's chat data attribute(`#1462`)
+- Dispatcher force updating persistence object's chat data attribute(`#1462`_)
 
 .. _`#1100`: https://github.com/python-telegram-bot/python-telegram-bot/pull/1100
 .. _`#1283`: https://github.com/python-telegram-bot/python-telegram-bot/pull/1283

docs/source/index.rst

@@ -22,7 +22,7 @@ Reference
 =========
 
 Below you can find a reference of all the classes and methods in python-telegram-bot.
-Apart from the telegram.ext package the objects should reflect the types defined in the `official telegram bot api documentation <https://core.telegram.org/bots/api>`_
+Apart from the `telegram.ext` package the objects should reflect the types defined in the `official telegram bot api documentation <https://core.telegram.org/bots/api>`_.
 
 .. toctree::
    telegram

docs/source/telegram.loginurl.rst

@@ -0,0 +1,6 @@
+telegram.LoginUrl
+=================
+
+.. autoclass:: telegram.LoginUrl
+    :members:
+    :show-inheritance:

docs/source/telegram.rst

@@ -32,6 +32,7 @@ telegram package
     telegram.inputmediavideo
     telegram.keyboardbutton
     telegram.location
+    telegram.loginurl
     telegram.message
     telegram.messageentity
     telegram.parsemode
@@ -141,8 +142,4 @@ Passport
     telegram.encryptedpassportelement
     telegram.encryptedcredentials
 
-telegram.utils
---------------
-
-.. toctree::
-    telegram.utils
+.. include:: telegram.utils.rst

telegram/ext/conversationhandler.py

@@ -57,11 +57,6 @@ class ConversationHandler(Handler):
     a regular text message is expected. You could use this for a ``/cancel`` command or to let the
     user know their message was not recognized.
 
-    The fourth, optional collection of handlers, a ``list`` named :attr:`timed_out_behavior` is
-    used if the wait for ``run_async`` takes longer than defined in :attr:`run_async_timeout`.
-    For example, you can let the user know that they should wait for a bit before they can
-    continue.
-
     To change the state of conversation, the callback function of a handler must return the new
     state after responding to the user. If it does not return anything (returning ``None`` by
     default), the state will not change. If an entry point callback function returns None,
@@ -86,7 +81,7 @@ class ConversationHandler(Handler):
             ID.
         conversation_timeout (:obj:`float`|:obj:`datetime.timedelta`): Optional. When this handler
             is inactive more than this timeout (in seconds), it will be automatically ended. If
-            this value is 0 (default), there will be no timeout. when it's triggered. The last
+            this value is 0 (default), there will be no timeout. When it's triggered, the last
             received update will be handled by ALL the handler's who's `check_update` method
             returns True that are in the state :attr:`ConversationHandler.TIMEOUT`.
         name (:obj:`str`): Optional. The name for this conversationhandler. Required for

telegram/loginurl.py

@@ -26,7 +26,8 @@ class LoginUrl(TelegramObject):
     authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is
     coming from Telegram. All the user needs to do is tap/click a button and confirm that they want
     to log in. Telegram apps support these buttons as of version 5.7.
-    Sample bot: @discussbot
+
+    Sample bot: `@discussbot <https://t.me/dicussbot>`_
 
     Attributes:
         url (:obj:`str`): An HTTP URL to be opened with user authorization data.

telegram/message.py

@@ -865,7 +865,7 @@ class Message(TelegramObject):
 
         Args:
             entity (:class:`telegram.MessageEntity`): The entity to extract the text from. It must
-            be an entity that belongs to this message.
+                be an entity that belongs to this message.
 
         Returns:
             :obj:`str`: The text of the given entity
@@ -890,7 +890,7 @@ class Message(TelegramObject):
 
         Args:
             entity (:class:`telegram.MessageEntity`): The entity to extract the text from. It must
-            be an entity that belongs to this message.
+                be an entity that belongs to this message.
 
         Returns:
             :obj:`str`: The text of the given entity