mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
[Docs] Fix driver docs showing twice (#3035)
* docs(config): fix doubled docs for drivers * enhance(drivers): add docstrings to enums that show in docs * chore(changelog): add towncrier entries
This commit is contained in:
parent
bc90f5186a
commit
f3c57b6730
1
changelog.d/2972.docs.rst
Normal file
1
changelog.d/2972.docs.rst
Normal file
@ -0,0 +1 @@
|
|||||||
|
Driver docs no longer show twice.
|
||||||
1
changelog.d/3035.docs.rst
Normal file
1
changelog.d/3035.docs.rst
Normal file
@ -0,0 +1 @@
|
|||||||
|
Add proper docstrings to enums that show in drivers docs.
|
||||||
@ -443,7 +443,12 @@ Value
|
|||||||
Driver Reference
|
Driver Reference
|
||||||
****************
|
****************
|
||||||
|
|
||||||
.. automodule:: redbot.core.drivers
|
.. autofunction:: redbot.core.drivers.get_driver
|
||||||
|
|
||||||
|
.. autoclass:: redbot.core.drivers.BackendType
|
||||||
|
:members:
|
||||||
|
|
||||||
|
.. autoclass:: redbot.core.drivers.ConfigCategory
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
Base Driver
|
Base Driver
|
||||||
@ -456,3 +461,7 @@ JSON Driver
|
|||||||
.. autoclass:: redbot.core.drivers.JsonDriver
|
.. autoclass:: redbot.core.drivers.JsonDriver
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
Postgres Driver
|
||||||
|
^^^^^^^^^^^^^^^
|
||||||
|
.. autoclass:: redbot.core.drivers.PostgresDriver
|
||||||
|
:members:
|
||||||
|
|||||||
@ -18,9 +18,13 @@ __all__ = [
|
|||||||
|
|
||||||
|
|
||||||
class BackendType(enum.Enum):
|
class BackendType(enum.Enum):
|
||||||
|
"""Represents storage backend type."""
|
||||||
|
|
||||||
|
#: JSON storage backend.
|
||||||
JSON = "JSON"
|
JSON = "JSON"
|
||||||
|
#: Postgres storage backend.
|
||||||
POSTGRES = "Postgres"
|
POSTGRES = "Postgres"
|
||||||
# Dead drivrs below retained for error handling.
|
# Dead drivers below retained for error handling.
|
||||||
MONGOV1 = "MongoDB"
|
MONGOV1 = "MongoDB"
|
||||||
MONGO = "MongoDBV2"
|
MONGO = "MongoDBV2"
|
||||||
|
|
||||||
|
|||||||
@ -6,11 +6,19 @@ __all__ = ["BaseDriver", "IdentifierData", "ConfigCategory"]
|
|||||||
|
|
||||||
|
|
||||||
class ConfigCategory(str, enum.Enum):
|
class ConfigCategory(str, enum.Enum):
|
||||||
|
"""Represents config category."""
|
||||||
|
|
||||||
|
#: Global category.
|
||||||
GLOBAL = "GLOBAL"
|
GLOBAL = "GLOBAL"
|
||||||
|
#: Guild category.
|
||||||
GUILD = "GUILD"
|
GUILD = "GUILD"
|
||||||
|
#: Channel category.
|
||||||
CHANNEL = "TEXTCHANNEL"
|
CHANNEL = "TEXTCHANNEL"
|
||||||
|
#: Role category.
|
||||||
ROLE = "ROLE"
|
ROLE = "ROLE"
|
||||||
|
#: User category.
|
||||||
USER = "USER"
|
USER = "USER"
|
||||||
|
#: Member category.
|
||||||
MEMBER = "MEMBER"
|
MEMBER = "MEMBER"
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user