hoelee/Telethon
1
0
Fork 0
mirror of https://github.com/LonamiWebs/Telethon.git synced 2025-08-09 13:29:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clear-up documentation by separating reference from examples

Browse Source
This commit is contained in:
Lonami Exo
2018-03-14 19:38:36 +01:00
parent 8ae12fbb70
commit 81944262fb
7 changed files with 51 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
readthedocs/extra/basic/telegram-client.rst
View File

@@ -8,6 +8,11 @@ TelegramClient
Introduction
************
.. note::
Check the :ref:`telethon-package` if you're looking for the methods
reference instead of this tutorial.
The ``TelegramClient`` is the central class of the library, the one
you will be using most of the time. For this reason, it's important
to know what it offers.
@@ -86,13 +91,7 @@ Please refer to :ref:`accessing-the-full-api` if these aren't enough,
and don't be afraid to read the source code of the InteractiveTelegramClient_
or even the TelegramClient_ itself to learn how it works.
To see the methods available in the client, see :ref:`telethon-package`.
.. _InteractiveTelegramClient: https://github.com/LonamiWebs/Telethon/blob/master/telethon_examples/interactive_telegram_client.py
.. _TelegramClient: https://github.com/LonamiWebs/Telethon/blob/master/telethon/telegram_client.py
.. automodule:: telethon.telegram_client
:members:
:undoc-members:
:show-inheritance: