Small documentation fixes
This commit is contained in:
Dan
parent
bf71989bd0
commit
b4f0f411bd
@ -68,7 +68,7 @@ To challenge the framework, the creator is constantly keeping a public
|
|||||||
`welcome bot <https://github.com/pyrogram/pyrogram/blob/develop/examples/welcomebot.py>`_ online 24/7 on his own,
|
`welcome bot <https://github.com/pyrogram/pyrogram/blob/develop/examples/welcomebot.py>`_ online 24/7 on his own,
|
||||||
relatively-busy account for well over a year now.
|
relatively-busy account for well over a year now.
|
||||||
|
|
||||||
In addition to that, about six months ago, one of the most popular Telegram bot has been rewritten
|
In addition to that, about six months ago, one of the most popular Telegram bot has been rewritten from scratch
|
||||||
:doc:`using Pyrogram <powered-by>` and is serving more than 200,000 Monthly Active Users since
|
:doc:`using Pyrogram <powered-by>` and is serving more than 200,000 Monthly Active Users since
|
||||||
then, uninterruptedly and without any need for restarting it.
|
then, uninterruptedly and without any need for restarting it.
|
||||||
|
|
||||||
@ -134,8 +134,8 @@ If you -- even accidentally -- fail to do so, all the previous session copies wi
|
|||||||
and eventually the server will start throwing the error ``[406 AUTH_KEY_DUPLICATED]``, inviting you to login again.
|
and eventually the server will start throwing the error ``[406 AUTH_KEY_DUPLICATED]``, inviting you to login again.
|
||||||
|
|
||||||
Why is that so? Because the server has recognized two identical sessions are running in two different locations, and
|
Why is that so? Because the server has recognized two identical sessions are running in two different locations, and
|
||||||
concludes it could possibly be due to a cloned/stolen device. Having the session ended in such occasions will protect
|
concludes it could possibly be due to a cloned/stolen device. Having the session terminated in such occasions will
|
||||||
the user's privacy.
|
protect the user's privacy.
|
||||||
|
|
||||||
So, the only correct way to run multiple clients on the same account is authorizing your account (either user or bot)
|
So, the only correct way to run multiple clients on the same account is authorizing your account (either user or bot)
|
||||||
from the beginning every time, and use one separate session for each parallel client you are going to use.
|
from the beginning every time, and use one separate session for each parallel client you are going to use.
|
||||||
|
|||||||
@ -1,93 +1,6 @@
|
|||||||
Welcome to Pyrogram
|
Welcome to Pyrogram
|
||||||
===================
|
===================
|
||||||
|
|
||||||
.. raw:: html
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<a href="/">
|
|
||||||
<div><img src="_static/pyrogram.png" alt="Pyrogram Logo" width="420"></div>
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<b>Telegram MTProto API Framework for Python</b>
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<a href="https://github.com/pyrogram/pyrogram">
|
|
||||||
Source Code
|
|
||||||
</a>
|
|
||||||
•
|
|
||||||
<a href="https://github.com/pyrogram/pyrogram/releases">
|
|
||||||
Releases
|
|
||||||
</a>
|
|
||||||
•
|
|
||||||
<a href="https://t.me/Pyrogram">
|
|
||||||
Community
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
from pyrogram import Client, Filters
|
|
||||||
|
|
||||||
app = Client("my_account")
|
|
||||||
|
|
||||||
|
|
||||||
@app.on_message(Filters.private)
|
|
||||||
def hello(client, message):
|
|
||||||
message.reply("Hello {}".format(message.from_user.first_name))
|
|
||||||
|
|
||||||
|
|
||||||
app.run()
|
|
||||||
|
|
||||||
**Pyrogram** is an elegant, easy-to-use Telegram_ client library and framework written from the ground up in Python and
|
|
||||||
C. It enables you to easily create custom apps for both user and bot identities (bot API alternative) via the
|
|
||||||
:doc:`MTProto API <topics/mtproto-vs-botapi>`.
|
|
||||||
|
|
||||||
.. _Telegram: https://telegram.org
|
|
||||||
|
|
||||||
How the Documentation is Organized
|
|
||||||
----------------------------------
|
|
||||||
|
|
||||||
Contents are organized into self-contained topics and can be all accessed from the sidebar, or by following them in
|
|
||||||
order using the :guilabel:`Next` button at the end of each page. Here below you can, instead, find a list of the most
|
|
||||||
relevant pages for a quick access.
|
|
||||||
|
|
||||||
First Steps
|
|
||||||
-----------
|
|
||||||
|
|
||||||
.. hlist::
|
|
||||||
:columns: 2
|
|
||||||
|
|
||||||
- :doc:`Quick Start <intro/quickstart>`: Overview to get you started quickly.
|
|
||||||
- :doc:`Calling Methods <start/invoking>`: How to call Pyrogram's methods.
|
|
||||||
- :doc:`Handling Updates <start/updates>`: How to handle Telegram updates.
|
|
||||||
- :doc:`Error Handling <start/errors>`: How to handle API errors correctly.
|
|
||||||
|
|
||||||
API Reference
|
|
||||||
-------------
|
|
||||||
|
|
||||||
.. hlist::
|
|
||||||
:columns: 2
|
|
||||||
|
|
||||||
- :doc:`Pyrogram Client <api/client>`: Reference details about the Client class.
|
|
||||||
- :doc:`Available Methods <api/methods>`: List of available high-level methods.
|
|
||||||
- :doc:`Available Types <api/types>`: List of available high-level types.
|
|
||||||
- :doc:`Bound Methods <api/bound-methods>`: List of convenient bound methods.
|
|
||||||
|
|
||||||
Meta
|
|
||||||
----
|
|
||||||
|
|
||||||
.. hlist::
|
|
||||||
:columns: 2
|
|
||||||
|
|
||||||
- :doc:`Pyrogram FAQ <faq>`: Answers to common Pyrogram questions.
|
|
||||||
- :doc:`Pyrogram Glossary <glossary>`: List of words with brief explanations.
|
|
||||||
- :doc:`Powered by Pyrogram <powered-by>`: Collection of Pyrogram Projects.
|
|
||||||
- :doc:`Support Pyrogram <support-pyrogram>`: Ways to show your appreciation.
|
|
||||||
- :doc:`About the License <license>`: Information about the Project license.
|
|
||||||
- :doc:`Release Notes <releases/index>`: Release notes for Pyrogram releases.
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:hidden:
|
:hidden:
|
||||||
:caption: Introduction
|
:caption: Introduction
|
||||||
@ -159,4 +72,91 @@ Meta
|
|||||||
telegram/functions/index
|
telegram/functions/index
|
||||||
telegram/types/index
|
telegram/types/index
|
||||||
|
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<a href="/">
|
||||||
|
<div><img src="_static/pyrogram.png" alt="Pyrogram Logo" width="420"></div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<b>Telegram MTProto API Framework for Python</b>
|
||||||
|
|
||||||
|
<br>
|
||||||
|
<a href="https://github.com/pyrogram/pyrogram">
|
||||||
|
Source Code
|
||||||
|
</a>
|
||||||
|
•
|
||||||
|
<a href="https://github.com/pyrogram/pyrogram/releases">
|
||||||
|
Releases
|
||||||
|
</a>
|
||||||
|
•
|
||||||
|
<a href="https://t.me/Pyrogram">
|
||||||
|
Community
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
from pyrogram import Client, Filters
|
||||||
|
|
||||||
|
app = Client("my_account")
|
||||||
|
|
||||||
|
|
||||||
|
@app.on_message(Filters.private)
|
||||||
|
def hello(client, message):
|
||||||
|
message.reply("Hello {}".format(message.from_user.first_name))
|
||||||
|
|
||||||
|
|
||||||
|
app.run()
|
||||||
|
|
||||||
|
**Pyrogram** is an elegant, easy-to-use Telegram_ client library and framework written from the ground up in Python and
|
||||||
|
C. It enables you to easily create custom apps for both user and bot identities (bot API alternative) via the
|
||||||
|
:doc:`MTProto API <topics/mtproto-vs-botapi>`.
|
||||||
|
|
||||||
|
.. _Telegram: https://telegram.org
|
||||||
|
|
||||||
|
How the Documentation is Organized
|
||||||
|
----------------------------------
|
||||||
|
|
||||||
|
Contents are organized into self-contained topics and can be all accessed from the sidebar, or by following them in
|
||||||
|
order using the :guilabel:`Next` button at the end of each page. Here below you can, instead, find a list of the most
|
||||||
|
relevant pages for a quick access.
|
||||||
|
|
||||||
|
First Steps
|
||||||
|
^^^^^^^^^^^
|
||||||
|
|
||||||
|
.. hlist::
|
||||||
|
:columns: 2
|
||||||
|
|
||||||
|
- :doc:`Quick Start <intro/quickstart>`: Overview to get you started quickly.
|
||||||
|
- :doc:`Calling Methods <start/invoking>`: How to call Pyrogram's methods.
|
||||||
|
- :doc:`Handling Updates <start/updates>`: How to handle Telegram updates.
|
||||||
|
- :doc:`Error Handling <start/errors>`: How to handle API errors correctly.
|
||||||
|
|
||||||
|
API Reference
|
||||||
|
^^^^^^^^^^^^^
|
||||||
|
|
||||||
|
.. hlist::
|
||||||
|
:columns: 2
|
||||||
|
|
||||||
|
- :doc:`Pyrogram Client <api/client>`: Reference details about the Client class.
|
||||||
|
- :doc:`Available Methods <api/methods>`: List of available high-level methods.
|
||||||
|
- :doc:`Available Types <api/types>`: List of available high-level types.
|
||||||
|
- :doc:`Bound Methods <api/bound-methods>`: List of convenient bound methods.
|
||||||
|
|
||||||
|
Meta
|
||||||
|
^^^^
|
||||||
|
|
||||||
|
.. hlist::
|
||||||
|
:columns: 2
|
||||||
|
|
||||||
|
- :doc:`Pyrogram FAQ <faq>`: Answers to common Pyrogram questions.
|
||||||
|
- :doc:`Pyrogram Glossary <glossary>`: List of words with brief explanations.
|
||||||
|
- :doc:`Powered by Pyrogram <powered-by>`: Collection of Pyrogram Projects.
|
||||||
|
- :doc:`Support Pyrogram <support-pyrogram>`: Ways to show your appreciation.
|
||||||
|
- :doc:`About the License <license>`: Information about the Project license.
|
||||||
|
- :doc:`Release Notes <releases/index>`: Release notes for Pyrogram releases.
|
||||||
|
|
||||||
Last updated on |today|
|
Last updated on |today|
|
||||||
Loading…
Reference in New Issue
Block a user