Skip to content

Commit

Permalink
Add typing annotations to reddit/models/mixins/__init__.py
Browse files Browse the repository at this point in the history
(cherry picked from commit praw-dev/praw@fb3441a)
  • Loading branch information
LilSpazJoekp committed Jun 7, 2022
1 parent a8324fb commit c20d3b1
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
22 changes: 11 additions & 11 deletions asyncpraw/models/reddit/redditor.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ def stream(self) -> "asyncpraw.models.reddit.redditor.RedditorStream":
print(comment)
Additionally, new submissions can be retrieved via the stream. In the following
example all submissions are fetched via the redditor ``spez``:
example all submissions are fetched via the redditor u/spez:
.. code-block:: python
Expand Down Expand Up @@ -182,7 +182,7 @@ async def _friend(self, method, data):
async def block(self):
"""Block the :class:`.Redditor`.
For example, to block :class:`.Redditor` ``spez``:
For example, to block :class:`.Redditor` u/spez:
.. code-block:: python
Expand All @@ -203,7 +203,7 @@ async def block(self):
async def distrust(self):
"""Remove the :class:`.Redditor` from your whitelist of trusted users.
For example, to remove :class:`.Redditor` ``spez`` from your whitelist:
For example, to remove :class:`.Redditor` u/spez from your whitelist:
.. code-block:: python
Expand All @@ -227,7 +227,7 @@ async def friend(self, note: str = None):
Calling this method subsequent times will update the note.
For example, to friend :class:`.Redditor` ``spez``:
For example, to friend :class:`.Redditor` u/spez:
.. code-block:: python
Expand All @@ -250,7 +250,7 @@ async def friend_info(self) -> "asyncpraw.models.Redditor":
:returns: A :class:`.Redditor` instance with fields ``date``, ``id``, and
possibly ``note`` if the authenticated user has Reddit Premium.
For example, to get the friendship information of :class:`.Redditor` ``spez``:
For example, to get the friendship information of :class:`.Redditor` u/spez:
.. code-block:: python
Expand All @@ -266,7 +266,7 @@ async def gild(self, months: int = 1):
:param months: Specifies the number of months to gild up to 36 (default: ``1``).
For example, to gild :class:`.Redditor` ``spez`` for 1 month:
For example, to gild :class:`.Redditor` u/spez for 1 month:
.. code-block:: python
Expand Down Expand Up @@ -334,7 +334,7 @@ async def moderated(self) -> List["asyncpraw.models.Subreddit"]:
async def multireddits(self) -> List["asyncpraw.models.Multireddit"]:
"""Return a list of the redditor's public multireddits.
For example, to to get :class:`.Redditor` ``spez``'s multireddits:
For example, to to get :class:`.Redditor` u/spez's multireddits:
.. code-block:: python
Expand Down Expand Up @@ -407,7 +407,7 @@ async def trust(self):
async def unblock(self):
"""Unblock the :class:`.Redditor`.
For example, to unblock :class:`.Redditor` ``spez``:
For example, to unblock :class:`.Redditor` u/spez:
.. code-block:: python
Expand All @@ -427,7 +427,7 @@ async def unblock(self):
async def unfriend(self):
"""Unfriend the :class:`.Redditor`.
For example, to unfriend :class:`.Redditor` ``spez``:
For example, to unfriend :class:`.Redditor` u/spez:
.. code-block:: python
Expand Down Expand Up @@ -459,7 +459,7 @@ def comments(
Keyword arguments are passed to :func:`.stream_generator`.
For example, to retrieve all new comments made by redditor ``spez``, try:
For example, to retrieve all new comments made by redditor u/spez, try:
.. code-block:: python
Expand All @@ -480,7 +480,7 @@ def submissions(
Keyword arguments are passed to :func:`.stream_generator`.
For example, to retrieve all new submissions made by redditor ``spez``, try:
For example, to retrieve all new submissions made by redditor u/spez, try:
.. code-block:: python
Expand Down
4 changes: 2 additions & 2 deletions asyncpraw/models/reddit/wikipage.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ async def add(self, redditor: "asyncpraw.models.Redditor"):
:param redditor: A redditor name or :class:`.Redditor` instance.
To add ``"spez"`` as an editor on the wikipage ``"praw_test"`` try:
To add u/spez as an editor on the wikipage ``"praw_test"`` try:
.. code-block:: python
Expand All @@ -65,7 +65,7 @@ async def remove(self, redditor: "asyncpraw.models.Redditor"):
:param redditor: A redditor name or :class:`.Redditor` instance.
To remove ``"spez"`` as an editor on the wikipage ``"praw_test"`` try:
To remove u/spez as an editor on the wikipage ``"praw_test"`` try:
.. code-block:: python
Expand Down

0 comments on commit c20d3b1

Please sign in to comment.