Skip to content

Commit 2a79243

Browse files
committed
Rename and rework Setup docs page
1 parent 95e16c2 commit 2a79243

2 files changed

Lines changed: 11 additions & 9 deletions

File tree

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
Project Setup
2-
=============
1+
Setup
2+
=====
33

4-
This section provides all the information you need to setup your project with Pyrogram.
5-
There are a few steps you have to follow before you can actually use the library to make API calls.
4+
Once you successfully installed_ Pyrogram, you will have to follow a few steps before you can actually use
5+
the library to make API calls. This section provides all the information you need in order to set up a project
6+
with Pyrogram.
67

78
API Keys
89
--------
@@ -45,7 +46,7 @@ There are two ways to configure a Pyrogram application project, and you can choo
4546
)
4647
4748
.. note:: The examples below assume you have created a ``config.ini`` file, thus they won't show the *api_id*
48-
and *api_hash* parameters usage.
49+
and *api_hash* parameters usage.
4950

5051
User Authorization
5152
------------------
@@ -75,14 +76,14 @@ After successfully authorizing yourself, a new file called ``my_account.session`
7576
Pyrogram executing API calls with your identity. This file will be loaded again when you restart your app,
7677
and as long as you keep the session alive, Pyrogram won't ask you again to enter your phone number.
7778

78-
.. important:: Your *.session file(s) must be kept secret.
79+
.. important:: Your ``*.session`` file(s) must be kept secret.
7980

8081
Bot Authorization
8182
-----------------
8283

8384
Being written entirely from the ground up, Pyrogram is also able to authorize Bots.
84-
Bots are a special kind of users which also make use of MTProto. This means that you can use Pyrogram to
85-
execute API calls with a Bot identity.
85+
Bots are a special kind of users which also make use of MTProto, the underlying Telegram protocol.
86+
This means that you can use Pyrogram to execute API calls with a Bot identity.
8687

8788
Instead of phone numbers, Bots are authorized via their tokens which are created by BotFather_:
8889

@@ -96,5 +97,6 @@ Instead of phone numbers, Bots are authorized via their tokens which are created
9697
That's all, no further action is needed. The session file will be named after the Bot user_id, which is
9798
``123456.session`` for the example above.
9899

100+
.. _installed: Installation.html
99101
.. _`Country Code`: https://en.wikipedia.org/wiki/List_of_country_calling_codes
100102
.. _BotFather: https://t.me/botfather

pyrogram/api/errors/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@
1616
# You should have received a copy of the GNU Lesser General Public License
1717
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
1818

19-
from .error import UnknownError
2019
from .exceptions import *
20+
from .error import UnknownError

0 commit comments

Comments
 (0)