TeamPGM/pyrogram
2
0
Fork 0
mirror of https://github.com/TeamPGM/pyrogram.git synced 2024-11-24 07:51:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document undocumented properties

Browse Source
This commit is contained in:
Dan 2020-08-26 08:10:34 +02:00
parent 15f504a91f
commit c5dd474f93
3 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
compiler/docs/compiler.py
View File

@ -416,7 +416,8 @@ def pyrogram_api():
title = "{}".format(type) title = "{}".format(type)
f2.write(title + "\n" + "=" * len(title) + "\n\n") f2.write(title + "\n" + "=" * len(title) + "\n\n")
f2.write(".. autoclass:: pyrogram.types.{}()".format(type)) f2.write(".. autoclass:: pyrogram.types.{}()\n".format(type))
f2.write(" :members:\n")
f.write(template.format(**fmt_keys)) f.write(template.format(**fmt_keys))

4
pyrogram/types/messages_and_media/message.py
View File

@ -245,9 +245,6 @@ class Message(Object, Update):
Messages sent from yourself to other chats are outgoing (*outgoing* is True). Messages sent from yourself to other chats are outgoing (*outgoing* is True).
An exception is made for your own personal chat; messages sent there will be incoming. An exception is made for your own personal chat; messages sent there will be incoming.
link (``str``):
A link to the message, only for groups and channels.
matches (List of regex Matches, *optional*): matches (List of regex Matches, *optional*):
A list containing all `Match Objects <https://docs.python.org/3/library/re.html#match-objects>`_ that match A list containing all `Match Objects <https://docs.python.org/3/library/re.html#match-objects>`_ that match
the text of this message. Only applicable when using :obj:`Filters.regex <pyrogram.Filters.regex>`. the text of this message. Only applicable when using :obj:`Filters.regex <pyrogram.Filters.regex>`.
@ -675,6 +672,7 @@ class Message(Object, Update):
@property @property
def link(self) -> str: def link(self) -> str:
"""Generate a link to this message, only for groups and channels."""
if self.chat.type in ("group", "supergroup", "channel") and self.chat.username: if self.chat.type in ("group", "supergroup", "channel") and self.chat.username:
return f"https://t.me/{self.chat.username}/{self.message_id}" return f"https://t.me/{self.chat.username}/{self.message_id}"
else: else:

5
pyrogram/types/user_and_chats/user.py
View File

@ -192,6 +192,11 @@ class User(Object, Update):
@property @property
def mention(self): def mention(self):
"""Generate a text mention for this user.
You can use ``user.mention()`` to mention the user using their first name (styled using html), or
``user.mention("another name")`` for a custom name. To choose a different style
("html" or "md"/"markdown") use ``user.mention(style="md")``."""
return Link(f"tg://user?id={self.id}", self.first_name, self._client.parse_mode) return Link(f"tg://user?id={self.id}", self.first_name, self._client.parse_mode)
@staticmethod @staticmethod