CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 11:18:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

Document prefix preservation (#4085)

Browse Source 
* Document prefix preservation

* more docs

* ref fix

* update reservations to include dunders

* meh

* Add a broad exclusion in the guarantees section
This commit is contained in:
Michael H 2020-08-03 09:09:29 -04:00 committed by GitHub
parent c0b1e50a5f
commit c5a553a600
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/version_guarantees.rst
View File

@ -20,6 +20,11 @@ which is not private (even if not documented) should not break without notice.
Anything in the ``redbot.cogs`` and ``redbot.vendored`` modules or any of their submodules is specifically Anything in the ``redbot.cogs`` and ``redbot.vendored`` modules or any of their submodules is specifically
excluded from being guaranteed. excluded from being guaranteed.
Method names and names of attributes of classes, functions, extensions, and modules
provided by or provided to the bot should not begin with
``red_`` or be of the form ``__red_*__`` except as documented.
This allows us to add certain optional features non-breakingly without a name conflict.
Any RPC method exposed by Red may break without notice. Any RPC method exposed by Red may break without notice.
If you would like something in here to be guaranteed, If you would like something in here to be guaranteed,

25
redbot/core/commands/commands.py
View File

@ -261,6 +261,17 @@ class Command(CogCommandMixin, DPYCommand):
attributes listed below are simply additions to the ones listed attributes listed below are simply additions to the ones listed
with that class. with that class.
.. warning::
If you subclass this command, attributes and methods
must remain compatible.
None of your methods should start with ``red_`` or
be dunder names which start with red (eg. ``__red_test_thing__``)
unless to override behavior in a method designed to be overriden,
as this prefix is reserved for future methods in order to be
able to add features non-breakingly.
Attributes Attributes
---------- ----------
checks : List[`coroutine function`] checks : List[`coroutine function`]
@ -668,7 +679,7 @@ class Command(CogCommandMixin, DPYCommand):
See ``format_text_for_context`` for the actual implementation details See ``format_text_for_context`` for the actual implementation details
Cog creators may override this in their own command classes Cog creators may override this in their own command and cog classes
as long as the method signature stays the same. as long as the method signature stays the same.
Parameters Parameters
@ -1009,6 +1020,18 @@ class Cog(CogMixin, DPYCog, metaclass=DPYCogMeta):
Red's Cog base class Red's Cog base class
This includes a metaclass from discord.py This includes a metaclass from discord.py
.. warning::
None of your methods should start with ``red_`` or
be dunder names which start with red (eg. ``__red_test_thing__``)
unless to override behavior in a method designed to be overriden,
as this prefix is reserved for future methods in order to be
able to add features non-breakingly.
Attributes and methods must remain compatible
with discord.py and with any of red's methods and attributes.
""" """
__cog_commands__: Tuple[Command] __cog_commands__: Tuple[Command]