Organise documentation

This commit is contained in:
NCPlayz
2019-03-16 21:43:55 +00:00
committed by Rapptz
parent 5e65ec978c
commit fb02191b80
30 changed files with 417 additions and 419 deletions

View File

@ -651,7 +651,7 @@ class Command(_BaseCommand):
Returns
--------
bool
:class:`bool`
A boolean indicating if the command is on cooldown.
"""
if not self._buckets.valid:
@ -708,7 +708,7 @@ class Command(_BaseCommand):
Parameters
-----------
coro : :ref:`coroutine <coroutine>`
coro: :ref:`coroutine <coroutine>`
The coroutine to register as the local error handler.
Raises
@ -736,7 +736,7 @@ class Command(_BaseCommand):
Parameters
-----------
coro
coro: :ref:`coroutine <coroutine>`
The coroutine to register as the pre-invoke hook.
Raises
@ -763,7 +763,7 @@ class Command(_BaseCommand):
Parameters
-----------
coro
coro: :ref:`coroutine <coroutine>`
The coroutine to register as the post-invoke hook.
Raises
@ -863,7 +863,7 @@ class Command(_BaseCommand):
Returns
--------
bool
:class:`bool`
A boolean indicating if the command can be invoked.
"""
@ -963,7 +963,7 @@ class GroupMixin:
Parameters
-----------
name: str
name: :class:`str`
The name of the command to remove.
Returns
@ -1006,12 +1006,12 @@ class GroupMixin:
Parameters
-----------
name: str
name: :class:`str`
The name of the command to get.
Returns
--------
Command or subclass
:class:`Command` or subclass
The command that was requested. If not found, returns ``None``.
"""
@ -1170,7 +1170,7 @@ def command(name=None, cls=None, **attrs):
Parameters
-----------
name: str
name: :class:`str`
The name to create the command with. By default this uses the
function name unchanged.
cls
@ -1221,11 +1221,6 @@ def check(predicate):
These functions can either be regular functions or coroutines.
Parameters
-----------
predicate
The predicate to check if the command should be invoked.
Examples
---------
@ -1255,6 +1250,10 @@ def check(predicate):
async def only_me(ctx):
await ctx.send('Only you!')
Parameters
-----------
predicate: Callable[:class:`Context`, :class:`bool`]
The predicate to check if the command should be invoked.
"""
def decorator(func):
@ -1283,7 +1282,7 @@ def has_role(item):
Parameters
-----------
item: Union[int, str]
item: Union[:class:`int`, :class:`str`]
The name or ID of the role to check.
"""
@ -1308,7 +1307,7 @@ def has_any_role(*items):
Parameters
-----------
items
items: List[Union[:class:`str`, :class:`int`]]
An argument list of names or IDs to check that the member has roles wise.
Example
@ -1482,9 +1481,9 @@ def cooldown(rate, per, type=BucketType.default):
Parameters
------------
rate: int
rate: :class:`int`
The number of times a command can be used before triggering a cooldown.
per: float
per: :class:`float`
The amount of seconds to wait for a cooldown when it's been triggered.
type: ``BucketType``
The type of cooldown to have.