CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-20 09:56:05 -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
2 changed files with 29 additions and 1 deletions
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
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.
If you would like something in here to be guaranteed,