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

Continue documentation and matching documented behaviour

Browse Source
This commit is contained in:
Lonami Exo
2023-11-02 00:45:01 +01:00
parent 6e88264b28
commit 2def0a169c
21 changed files with 450 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
client/doc/basic/installation.rst
View File

@@ -29,10 +29,10 @@ Once you have a working Python 3 installation, you can install or upgrade the ``
.. code-block:: shell
python -m pip install --upgrade telethon
python -m pip install --upgrade "telethon~=2.0"
Be sure to use lock-files if your project!
The above is just a quick way to get started and install Telethon globally.
The above is just a quick way to get started and install a `v2-compatible <https://peps.python.org/pep-0440/#compatible-release>`_ Telethon globally.
Installing development versions
@@ -47,7 +47,7 @@ If you want the *latest* unreleased changes, you can run the following command i
.. note::
The development version may have bugs and is not recommended for production use.
However, when you are `reporting a library bug <https://github.com/LonamiWebs/Telethon/issues/>`,
However, when you are `reporting a library bug <https://github.com/LonamiWebs/Telethon/issues/>`_,
you must reproduce the issue in this version before reporting the problem.

9
client/doc/basic/signing-in.rst
View File

@@ -50,6 +50,8 @@ If the issue persists, you may try contacting them, using a proxy or using a VPN
Be aware that some phone numbers are not eligible to register applications with.
.. _interactive login:
Interactive login
-----------------
@@ -131,6 +133,11 @@ If you want to automatically login as a bot when needed, you can do so without a
Manual login
------------
.. tip::
You can safely skip to :doc:`next-steps` if you've already completed the :ref:`interactive login`.
This section is only of interest if you want more control over how to manually login.
We've talked about the second and third parameters of the :class:`Client` constructor, but not the first:
.. code-block:: python
@@ -143,7 +150,7 @@ The session path can contain directory separators and live anywhere in the file
Telethon will automatically append the ``.session`` extension if you don't provide any.
Briefly, the session contains some of the information needed to connect to Telegram.
This includes the datacenter belonging to the account logged-in, and the authorization key used for encryption, among other things.
This includes the data center belonging to the account logged-in, and the authorization key used for encryption, among other things.
.. important::