[commands] Update command.parent and command.parents docs
* Switch root_parent from command to group
This commit is contained in:
parent
fb20c4c3d4
commit
ef6f5d947a
@ -174,8 +174,8 @@ class Command(_BaseCommand):
|
|||||||
If the command is invoked while it is disabled, then
|
If the command is invoked while it is disabled, then
|
||||||
:exc:`.DisabledCommand` is raised to the :func:`.on_command_error`
|
:exc:`.DisabledCommand` is raised to the :func:`.on_command_error`
|
||||||
event. Defaults to ``True``.
|
event. Defaults to ``True``.
|
||||||
parent: Optional[:class:`Command`]
|
parent: Optional[:class:`Group`]
|
||||||
The parent command that this command belongs to. ``None`` if there
|
The parent group that this command belongs to. ``None`` if there
|
||||||
isn't one.
|
isn't one.
|
||||||
cog: Optional[:class:`Cog`]
|
cog: Optional[:class:`Cog`]
|
||||||
The cog that this command belongs to. ``None`` if there isn't one.
|
The cog that this command belongs to. ``None`` if there isn't one.
|
||||||
@ -556,7 +556,7 @@ class Command(_BaseCommand):
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def parents(self):
|
def parents(self):
|
||||||
"""List[:class:`Command`]: Retrieves the parents of this command.
|
"""List[:class:`Group`]: Retrieves the parents of this command.
|
||||||
|
|
||||||
If the command has no parents then it returns an empty :class:`list`.
|
If the command has no parents then it returns an empty :class:`list`.
|
||||||
|
|
||||||
@ -574,7 +574,7 @@ class Command(_BaseCommand):
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def root_parent(self):
|
def root_parent(self):
|
||||||
"""Optional[:class:`Command`]: Retrieves the root parent of this command.
|
"""Optional[:class:`Group`]: Retrieves the root parent of this command.
|
||||||
|
|
||||||
If the command has no parents then it returns ``None``.
|
If the command has no parents then it returns ``None``.
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user