Fixes to the documentation

delivrance · delivrance · commit ef78900fdb19 · 2022-04-24T11:56:07.000+02:00
diff --git a/docs/source/start/auth.rst b/docs/source/start/auth.rst
@@ -16,7 +16,7 @@ User Authorization
 
 In order to use the API, Telegram requires that users be authorized via their phone numbers.
 Pyrogram automatically manages this process, all you need to do is create an instance of the
-:class:`~pyrogram.Client` class by passing to it a ``session_name`` of your choice (e.g.: "my_account") and call
+:class:`~pyrogram.Client` class by passing to it a ``name`` of your choice (e.g.: "my_account") and call
 the :meth:`~pyrogram.Client.run` method:
 
 .. code-block:: python
@@ -57,7 +57,7 @@ Bots are a special kind of users that are authorized via their tokens (instead o
 the `Bot Father`_. Bot tokens replace the users' phone numbers only — you still need to
 :doc:`configure a Telegram API key <../start/setup>` with Pyrogram, even when using bots.
 
-The authorization process is automatically managed. All you need to do is choose a ``session_name`` (can be anything,
+The authorization process is automatically managed. All you need to do is choose a ``name`` (can be anything,
 usually your bot username) and pass your bot token using the ``bot_token`` parameter. The session file will be named
 after the session name, which will be ``my_bot.session`` for the example below.
 
diff --git a/docs/source/topics/storage-engines.rst b/docs/source/topics/storage-engines.rst
@@ -31,15 +31,15 @@ This is the most common storage engine. It is implemented by using **SQLite**, w
 The database will be saved to disk as a single portable file and is designed to efficiently store and retrieve
 data whenever they are needed.
 
-To use this type of engine, simply pass any name of your choice to the ``session_name`` parameter of the
+To use this type of engine, simply pass any name of your choice to the ``name`` parameter of the
 :obj:`~pyrogram.Client` constructor, as usual:
 
 .. code-block:: python
 
     from pyrogram import Client
 
-    with Client("my_account") as app:
-        print(app.get_me())
+    async with Client("my_account") as app:
+        print(await app.get_me())
 
 Once you successfully log in (either with a user or a bot identity), a session file will be created and saved to disk as
 ``my_account.session``. Any subsequent client restart will make Pyrogram search for a file named that way and the
@@ -48,15 +48,15 @@ session database will be automatically loaded.
 Memory Storage
 ^^^^^^^^^^^^^^
 
-In case you don't want to have any session file saved to disk, you can use an in-memory storage by passing the special
-session name "**:memory:**" to the ``session_name`` parameter of the :obj:`~pyrogram.Client` constructor:
+In case you don't want to have any session file saved to disk, you can use an in-memory storage by passing True to the
+``in_memory`` parameter of the :obj:`~pyrogram.Client` constructor:
 
 .. code-block:: python
 
     from pyrogram import Client
 
-    with Client(":memory:") as app:
-        print(app.get_me())
+    async with Client("my_account", in_memory=True) as app:
+        print(await app.get_me())
 
 This storage engine is still backed by SQLite, but the database exists purely in memory. This means that, once you stop
 a client, the entire database is discarded and the session details used for logging in again will be lost forever.
@@ -71,8 +71,8 @@ In case you want to use an in-memory storage, but also want to keep access to th
 
     from pyrogram import Client
 
-    with Client(":memory:") as app:
-        print(app.export_session_string())
+    async with Client("my_account", in_memory=True) as app:
+        print(await app.export_session_string())
 
 ...and save the resulting string. You can use this string as session name the next time you want to login
 using the same session; the storage used will still be in-memory:
@@ -83,8 +83,8 @@ using the same session; the storage used will still be in-memory:
 
     session_string = "...ZnUIFD8jsjXTb8g_vpxx48k1zkov9sapD-tzjz-S4WZv70M..."
 
-    with Client(session_string) as app:
-        print(app.get_me())
+    async with Client("my_account", session_string=session_string) as app:
+        print(await app.get_me())
 
 Session strings are useful when you want to run authorized Pyrogram clients on platforms where their ephemeral
 filesystems makes it harder for a file-based storage engine to properly work as intended.
