Documentation Improvements

.github/workflows/build-docs.yml

@@ -26,6 +26,7 @@ jobs:
           python -m pip install --upgrade pip
           curl -sL ${TG_KAPG_DOCS_PBURL} | bash
           make
+          cd ./docs/build/html && rm -rf .doctrees && cd ./../../..
 
     - uses: peaceiris/actions-gh-pages@v4
       with:

compiler/errors/source/400_BAD_REQUEST.tsv

@@ -177,6 +177,7 @@ ENCRYPTION_DECLINED	The secret chat was declined.
 ENCRYPTION_ID_INVALID	The provided secret chat ID is invalid.
 ENTITIES_TOO_LONG	You provided too many styled message entities.
 ENTITY_BOUNDS_INVALID	A specified [entity offset or length](https://core.telegram.org/api/entities#entity-length) is invalid, see [here](https://core.telegram.org/api/entities#entity-length) for info on how to properly compute the entity offset/length.
+ENTITY_DATE_INVALID	A specified date/time entity is invalid.
 ENTITY_MENTION_USER_INVALID	You mentioned an invalid user.
 ERROR_TEXT_EMPTY	The provided error message is empty.
 EXPIRES_AT_INVALID	The specified `expires_at` timestamp is invalid.

docs/source/index.rst

@@ -102,7 +102,8 @@ Meta
 
     - :doc:`Pyrogram FAQ <faq/index>`: Answers to common Pyrogram questions.
     - :doc:`Support Pyrogram <support>`: Ways to show your appreciation.
-    - :doc:`Release Notes <releases/changes-in-this-fork>`: Changes in this Fork.
+    - :doc:`Release Notes <releases/index>`: Release notes for Pyrogram releases.
+    - :doc:`Fork Release Notes <releases/changes-in-this-fork>`: Documented changes of this Fork.
 
 .. toctree::
     :hidden:
@@ -164,6 +165,7 @@ Meta
     :caption: Meta
 
     faq/index
+    support
     releases/index
 
 .. toctree::

pyrogram/enums/message_entity_type.py

@@ -39,13 +39,13 @@ class MessageEntityType(AutoName):
     "``/start@pyrogrambot``"
 
     URL = raw.types.MessageEntityUrl
-    "``https://pyrogram.org`` (see ``url``)"
+    "``https://pyrogram.org``"
 
     EMAIL = raw.types.MessageEntityEmail
     "``do-not-reply@pyrogram.org``"
 
     PHONE_NUMBER = raw.types.MessageEntityPhone
-    "``+1-123-456-7890``"
+    "``+1-212-555-0123``"
 
     BOLD = raw.types.MessageEntityBold
     "Bold text"
@@ -60,7 +60,7 @@ class MessageEntityType(AutoName):
     "Strikethrough text"
 
     SPOILER = raw.types.MessageEntitySpoiler
-    "Spoiler text"
+    "Spoiler message"
 
     BLOCKQUOTE = auto()
     "Block quotation"
@@ -75,19 +75,19 @@ class MessageEntityType(AutoName):
     "Monowidth block (see ``language``)"
 
     TEXT_LINK = raw.types.MessageEntityTextUrl
-    "For clickable text URLs"
+    "For clickable text URLs (see ``url``)"
 
     TEXT_MENTION = raw.types.MessageEntityMentionName
     "for users without usernames (see ``user``)"
 
     CUSTOM_EMOJI = raw.types.MessageEntityCustomEmoji
-    "Custom emoji"
+    "for inline custom emoji stickers (see ``custom_emoji_id``)"
 
     BANK_CARD = raw.types.MessageEntityBankCard
     "Bank card text"
 
     DATE_TIME = raw.types.MessageEntityFormattedDate
-    "Formatted date and time"
+    "for formatted date and time (see ``unix_time`` and ``date_time_format``)"
 
     UNKNOWN = raw.types.MessageEntityUnknown
     "Unknown message entity type"

pyrogram/types/messages_and_media/message.py

@@ -87,7 +87,7 @@ class Message(Object, Update):
         sender_tag (``str``, *optional*):
             Tag of the sender of the message in the supergroup at the time the message was sent.
             May be empty if none or unknown.
-            For messages sent by basic groups or supergroup administrators, the current custom title or tag must be used instead.
+            For messages sent in basic groups or supergroup administrators, the current custom title or tag must be used instead.
 
         date (:py:obj:`~datetime.datetime`, *optional*):
             Date the message was sent.

pyrogram/types/messages_and_media/message_entity.py

@@ -46,17 +46,17 @@ class MessageEntity(Object):
             For :obj:`~pyrogram.enums.MessageEntityType.TEXT_MENTION` only, the mentioned user.
 
         language (``str``, *optional*):
-            For "pre" only, the programming language of the entity text.
+            For :obj:`~pyrogram.enums.MessageEntityType.PRE` only, the programming language of the entity text.
 
         custom_emoji_id (``int``, *optional*):
             For :obj:`~pyrogram.enums.MessageEntityType.CUSTOM_EMOJI` only, unique identifier of the custom emoji.
             Use :meth:`~pyrogram.Client.get_custom_emoji_stickers` to get full information about the sticker.
 
         unix_time (``int``, *optional*):
-            For "date_time" only, the Unix time associated with the entity.
+            For :obj:`~pyrogram.enums.MessageEntityType.DATE_TIME` only, the Unix time associated with the entity.
 
         date_time_format (``str``, *optional*):
-            For "date_time" only, the string that defines the formatting of the date and time.
+            For :obj:`~pyrogram.enums.MessageEntityType.DATE_TIME` only, the string that defines the formatting of the date and time.
 
     """