mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-12-07 09:52:30 -05:00
Privatize APIs by renaming or removing them from __all__ (#6021)
This commit is contained in:
@@ -1,8 +0,0 @@
|
||||
.. cog manager docs
|
||||
|
||||
===========
|
||||
Cog Manager
|
||||
===========
|
||||
|
||||
.. automodule:: redbot.core.cog_manager
|
||||
:members:
|
||||
@@ -540,30 +540,14 @@ Value
|
||||
:members:
|
||||
:special-members: __call__
|
||||
|
||||
IdentifierData
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
****************
|
||||
Driver Reference
|
||||
****************
|
||||
|
||||
.. autofunction:: redbot.core.drivers.get_driver
|
||||
|
||||
.. autoclass:: redbot.core.drivers.BackendType
|
||||
.. autoclass:: IdentifierData
|
||||
:members:
|
||||
|
||||
.. autoclass:: redbot.core.drivers.ConfigCategory
|
||||
:members:
|
||||
ConfigCategory
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
Base Driver
|
||||
^^^^^^^^^^^
|
||||
.. autoclass:: redbot.core.drivers.BaseDriver
|
||||
:members:
|
||||
|
||||
JSON Driver
|
||||
^^^^^^^^^^^
|
||||
.. autoclass:: redbot.core.drivers.JsonDriver
|
||||
:members:
|
||||
|
||||
Postgres Driver
|
||||
^^^^^^^^^^^^^^^
|
||||
.. autoclass:: redbot.core.drivers.PostgresDriver
|
||||
.. autoclass:: ConfigCategory
|
||||
:members:
|
||||
|
||||
@@ -69,7 +69,6 @@ Welcome to Red - Discord Bot's documentation!
|
||||
framework_bank
|
||||
framework_bot
|
||||
framework_checks
|
||||
framework_cogmanager
|
||||
framework_commands
|
||||
framework_config
|
||||
framework_datamanager
|
||||
|
||||
@@ -87,8 +87,17 @@ Ubuntu 22.10 x86-64, aarch64 2023-07-31 (`End of
|
||||
Developer Guarantees
|
||||
====================
|
||||
|
||||
Anything in the ``redbot.core`` module or any of its submodules
|
||||
which is not private (even if not documented) should not break without notice.
|
||||
Any name (function, class, attribute) listed in the ``__all__`` attribute of
|
||||
the ``redbot`` module (excluding its submodules), ``redbot.core`` package,
|
||||
or any of its public submodules (modules that do not start with "_")
|
||||
is considered a public API and should not break without notice.
|
||||
|
||||
Methods of public classes are considered public if they do not start with "_"
|
||||
or are dunder methods (e.g. ``method()`` and ``__getattr__()`` are public but ``_method()`` isn't).
|
||||
|
||||
Any other name (function, class, attribute) in the ``redbot`` package is considered private,
|
||||
even if it doesn't start with "_".
|
||||
Lack of ``__all__`` in the module means that all of its names are considered private APIs.
|
||||
|
||||
Anything in the ``redbot.cogs`` and ``redbot.vendored`` modules or any of their submodules is specifically
|
||||
excluded from being guaranteed.
|
||||
@@ -100,6 +109,9 @@ This allows us to add certain optional features non-breakingly without a name co
|
||||
|
||||
Any RPC method exposed by Red may break without notice.
|
||||
|
||||
Any exclusion from these guarantees should be noted in the documentation of
|
||||
the affected attribute, function, class, or method.
|
||||
|
||||
If you would like something in here to be guaranteed,
|
||||
open an issue making a case for it to be moved.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user