From 65061f8a99c603478271689f2f0bab5587641e54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannes=20H=C3=B6ke?= Date: Tue, 1 Nov 2016 09:01:36 +0100 Subject: [PATCH] [ci skip] docs: add all missing classes --- docs/source/telegram.animation.rst | 7 ++++++ docs/source/telegram.callbackgame.rst | 7 ++++++ docs/source/telegram.chatmember.rst | 7 ++++++ docs/source/telegram.game.rst | 7 ++++++ docs/source/telegram.gamehighscore.rst | 7 ++++++ docs/source/telegram.keyboardbutton.rst | 7 ++++++ docs/source/telegram.messageentity.rst | 7 ++++++ docs/source/telegram.parsemode.rst | 7 ++++++ docs/source/telegram.rst | 32 ++++++++++++++++--------- docs/source/telegram.venue.rst | 7 ++++++ docs/source/telegram.webhookinfo.rst | 7 ++++++ telegram/game.py | 4 ++-- telegram/message.py | 8 +++---- 13 files changed, 97 insertions(+), 17 deletions(-) create mode 100644 docs/source/telegram.animation.rst create mode 100644 docs/source/telegram.callbackgame.rst create mode 100644 docs/source/telegram.chatmember.rst create mode 100644 docs/source/telegram.game.rst create mode 100644 docs/source/telegram.gamehighscore.rst create mode 100644 docs/source/telegram.keyboardbutton.rst create mode 100644 docs/source/telegram.messageentity.rst create mode 100644 docs/source/telegram.parsemode.rst create mode 100644 docs/source/telegram.venue.rst create mode 100644 docs/source/telegram.webhookinfo.rst diff --git a/docs/source/telegram.animation.rst b/docs/source/telegram.animation.rst new file mode 100644 index 000000000..cb79d78df --- /dev/null +++ b/docs/source/telegram.animation.rst @@ -0,0 +1,7 @@ +telegram.animation module +========================= + +.. automodule:: telegram.animation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/telegram.callbackgame.rst b/docs/source/telegram.callbackgame.rst new file mode 100644 index 000000000..abbe823ca --- /dev/null +++ b/docs/source/telegram.callbackgame.rst @@ -0,0 +1,7 @@ +telegram.callbackgame module +============================ + +.. automodule:: telegram.callbackgame + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/telegram.chatmember.rst b/docs/source/telegram.chatmember.rst new file mode 100644 index 000000000..96bb56d7d --- /dev/null +++ b/docs/source/telegram.chatmember.rst @@ -0,0 +1,7 @@ +telegram.chatmember module +========================== + +.. automodule:: telegram.chatmember + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/telegram.game.rst b/docs/source/telegram.game.rst new file mode 100644 index 000000000..3514a41f3 --- /dev/null +++ b/docs/source/telegram.game.rst @@ -0,0 +1,7 @@ +telegram.game module +==================== + +.. automodule:: telegram.game + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/telegram.gamehighscore.rst b/docs/source/telegram.gamehighscore.rst new file mode 100644 index 000000000..d25879f32 --- /dev/null +++ b/docs/source/telegram.gamehighscore.rst @@ -0,0 +1,7 @@ +telegram.gamehighscore module +============================= + +.. automodule:: telegram.gamehighscore + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/telegram.keyboardbutton.rst b/docs/source/telegram.keyboardbutton.rst new file mode 100644 index 000000000..2c67605f2 --- /dev/null +++ b/docs/source/telegram.keyboardbutton.rst @@ -0,0 +1,7 @@ +telegram.keyboardbutton module +============================== + +.. automodule:: telegram.keyboardbutton + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/telegram.messageentity.rst b/docs/source/telegram.messageentity.rst new file mode 100644 index 000000000..d49789c38 --- /dev/null +++ b/docs/source/telegram.messageentity.rst @@ -0,0 +1,7 @@ +telegram.messageentity module +============================= + +.. automodule:: telegram.messageentity + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/telegram.parsemode.rst b/docs/source/telegram.parsemode.rst new file mode 100644 index 000000000..f9c194603 --- /dev/null +++ b/docs/source/telegram.parsemode.rst @@ -0,0 +1,7 @@ +telegram.parsemode module +========================= + +.. automodule:: telegram.parsemode + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/telegram.rst b/docs/source/telegram.rst index c1930fcb4..de1de9473 100644 --- a/docs/source/telegram.rst +++ b/docs/source/telegram.rst @@ -6,16 +6,28 @@ Submodules .. toctree:: + telegram.contrib + telegram.ext + telegram.animation telegram.audio telegram.base telegram.bot + telegram.callbackgame + telegram.chat + telegram.chataction + telegram.chatmember + telegram.choseninlineresult telegram.constants - telegram.contrib - telegram.ext - telegram.inlinequery - telegram.inlinequeryresult + telegram.contact + telegram.document + telegram.error + telegram.forcereply + telegram.game + telegram.gamehighscore telegram.inlinekeyboardbutton telegram.inlinekeyboardmarkup + telegram.inlinequery + telegram.inlinequeryresult telegram.inlinequeryresultarticle telegram.inlinequeryresultaudio telegram.inlinequeryresultcachedaudio @@ -35,16 +47,12 @@ Submodules telegram.inlinequeryresultvenue telegram.inlinequeryresultvideo telegram.inlinequeryresultvoice - telegram.choseninlineresult - telegram.chataction - telegram.contact - telegram.document - telegram.error - telegram.forcereply - telegram.chat telegram.inputfile + telegram.keyboardbutton telegram.location telegram.message + telegram.messageentity + telegram.parsemode telegram.photosize telegram.replykeyboardhide telegram.replykeyboardmarkup @@ -53,8 +61,10 @@ Submodules telegram.update telegram.user telegram.userprofilephotos + telegram.venue telegram.video telegram.voice + telegram.webhookinfo Module contents --------------- diff --git a/docs/source/telegram.venue.rst b/docs/source/telegram.venue.rst new file mode 100644 index 000000000..aef1a733e --- /dev/null +++ b/docs/source/telegram.venue.rst @@ -0,0 +1,7 @@ +telegram.venue module +===================== + +.. automodule:: telegram.venue + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/telegram.webhookinfo.rst b/docs/source/telegram.webhookinfo.rst new file mode 100644 index 000000000..8da483d97 --- /dev/null +++ b/docs/source/telegram.webhookinfo.rst @@ -0,0 +1,7 @@ +telegram.webhookinfo module +=========================== + +.. automodule:: telegram.webhookinfo + :members: + :undoc-members: + :show-inheritance: diff --git a/telegram/game.py b/telegram/game.py index a99eced30..989eac74a 100644 --- a/telegram/game.py +++ b/telegram/game.py @@ -101,8 +101,8 @@ class Game(TelegramObject): (That is, you can't just slice ``Message.text`` with the offset and length.) Args: - entity (MessageEntity): The entity to extract the text from. It must be an entity that - belongs to this message. + entity (telegram.MessageEntity): The entity to extract the text from. It must be an + entity that belongs to this message. Returns: str: The text of the given entity diff --git a/telegram/message.py b/telegram/message.py index da1b4e0d7..59efa62f7 100644 --- a/telegram/message.py +++ b/telegram/message.py @@ -507,8 +507,8 @@ class Message(TelegramObject): (That is, you can't just slice ``Message.text`` with the offset and length.) Args: - entity (MessageEntity): The entity to extract the text from. It must be an entity that - belongs to this message. + entity (telegram.MessageEntity): The entity to extract the text from. It must be an + entity that belongs to this message. Returns: str: The text of the given entity @@ -534,8 +534,8 @@ class Message(TelegramObject): See ``get_entity_text`` for more info. Args: - types (Optional[list]): List of ``MessageEntity`` types as strings. If the ``type`` - attribute of an entity is contained in this list, it will be returned. + types (Optional[list]): List of ``telegram.MessageEntity`` types as strings. If the + ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to a list of all types. All types can be found as constants in :class:`telegram.MessageEntity`.