Skip to content

Commit

Permalink
Fix documentation links to point to our fork
Browse files Browse the repository at this point in the history
  • Loading branch information
SpEcHiDe committed Jan 1, 2024
1 parent f9f5c8e commit 8149ff4
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 12 deletions.
8 changes: 4 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
Welcome to PyrogramMod
Welcome to Pyrogram-Mod
===================

.. raw:: html

<div align="center">
<a href="/">
<div class="pyrogram-logo-index"><img src="_static/pyrogram.png" alt="Pyrogram"></div>
<div class="pyrogram-text pyrogram-text-index">Pyrogram Mod</div>
<div class="pyrogram-text pyrogram-text-index">Pyrogram-Mod</div>
</a>
</div>

<p align="center">
<b>Telegram MTProto API Framework for Python</b>

<br>
<a href="https://pyrogrammod.github.io">
<a href="https://TelegramPlayGround.github.io/pyrogram/">
Homepage
</a>
<a href="https://github.com/pyrogram/pyrogram">
<a href="https://github.com/TelegramPlayGround/pyrogram">
Development
</a>
Expand Down
8 changes: 6 additions & 2 deletions docs/source/intro/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ Get Pyrogram Real Fast
:class: tip
If you need a cloud server to host your applications, try Hetzner Cloud. You can sign up with
`this link <https://hetzner.cloud/?ref=9CyT92gZEINU>`_ to get €20 in cloud credits.
`this link <https://hetzner.cloud/?ref=sKhf0eiXDgUT>`_ to get €20 in cloud credits.
1. Install Pyrogram with ``pip3 install -U https://github.com/pyrogrammod/pyrogrammod/archive/main.zip``.
0. Create a Virtual Environment with ``python3 -m venv venv``.

0. Activate the Virtual Environment with ``source ./venv/bin/activate``.

1. Install Pyrogram with ``pip uninstall -y pyrogram && pip install https://github.com/TelegramPlayGround/pyrogram/archive/unknown_errors.zip``.

2. Get your own Telegram API key from https://my.telegram.org/apps.

Expand Down
12 changes: 9 additions & 3 deletions pyrogram/methods/messages/set_message_reaction.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ async def set_message_reaction(
chat_id: Union[int, str],
message_id: int = None,
reaction: List["types.ReactionType"] = [],
is_big: bool = False
is_big: bool = False,
add_to_recent: bool = True
) -> "types.MessageReactions":
"""Use this method to change the chosen reactions on a message.
Service messages can't be reacted to.
Expand All @@ -54,8 +55,12 @@ async def set_message_reaction(
Pass True to set the reaction with a big animation.
Defaults to False.
add_to_recent (``bool``, *optional*):
Pass True if the reaction should appear in the recently used reactions.
This option is applicable only for users.
Defaults to True.
Returns:
:obj: `~pyrogram.types.MessageReactions`: On success, True is returned.
On success, List of :obj:`~pyrogram.types.MessageReactions`: is returned.
Example:
.. code-block:: python
Expand All @@ -78,7 +83,8 @@ async def set_message_reaction(
r.write(self)
for r in reaction
] if reaction else [raw.types.ReactionEmpty()],
big=is_big
big=is_big,
add_to_recent=add_to_recent
)
)
for i in r.updates:
Expand Down
8 changes: 5 additions & 3 deletions pyrogram/types/messages_and_media/message.py
Original file line number Diff line number Diff line change
Expand Up @@ -3356,7 +3356,8 @@ async def click(self, x: Union[int, str] = 0, y: int = None, quote: bool = None,
async def react(
self,
reaction: List["types.ReactionType"] = [],
is_big: bool = False
is_big: bool = False,
add_to_recent: bool = True
) -> "types.MessageReactions":
"""Bound method *react* of :obj:`~pyrogram.types.Message`.
Expand Down Expand Up @@ -3389,7 +3390,7 @@ async def react(
Defaults to False.
Returns:
:obj: `~pyrogram.types.MessageReactions`: On success, True is returned.
On success, List of :obj:`~pyrogram.types.MessageReactions`: is returned.
Raises:
RPCError: In case of a Telegram RPC error.
Expand All @@ -3399,7 +3400,8 @@ async def react(
chat_id=self.chat.id,
message_id=self.id,
reaction=reaction,
is_big=is_big
is_big=is_big,
add_to_recent=add_to_recent
)

async def retract_vote(
Expand Down

0 comments on commit 8149ff4

Please sign in to comment.