aboutsummaryrefslogtreecommitdiff
path: root/discord/ext/tasks
diff options
context:
space:
mode:
authorNihaal <[email protected]>2019-06-28 17:29:04 +0100
committerRapptz <[email protected]>2019-06-29 19:15:06 -0400
commit96877402177165b3d6272b501978a2c8edc3bf9b (patch)
treeb815e17a712c74920621f22c785b8c0187d11abf /discord/ext/tasks
parentRemove unused import (diff)
downloaddiscord.py-96877402177165b3d6272b501978a2c8edc3bf9b.tar.xz
discord.py-96877402177165b3d6272b501978a2c8edc3bf9b.zip
[tasks] Removed Returns from decorator docstring
Diffstat (limited to 'discord/ext/tasks')
-rw-r--r--discord/ext/tasks/__init__.py7
1 files changed, 1 insertions, 6 deletions
diff --git a/discord/ext/tasks/__init__.py b/discord/ext/tasks/__init__.py
index 9ea0b1ac..9d0e46bb 100644
--- a/discord/ext/tasks/__init__.py
+++ b/discord/ext/tasks/__init__.py
@@ -348,7 +348,7 @@ class Loop:
def loop(*, seconds=0, minutes=0, hours=0, count=None, reconnect=True, loop=None):
"""A decorator that schedules a task in the background for you with
- optional reconnect logic.
+ optional reconnect logic. The decorator returns a :class:`Loop`.
Parameters
------------
@@ -375,11 +375,6 @@ def loop(*, seconds=0, minutes=0, hours=0, count=None, reconnect=True, loop=None
An invalid value was given.
TypeError
The function was not a coroutine.
-
- Returns
- ---------
- :class:`Loop`
- The loop helper that handles the background task.
"""
def decorator(func):
return Loop(func, seconds=seconds, minutes=minutes, hours=hours,