[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:
jack1142 2020-01-02 14:54:25 +01:00 committed by Michael H
parent bc90f5186a
commit f3c57b6730
5 changed files with 25 additions and 2 deletions

View File

@ -0,0 +1 @@
Driver docs no longer show twice.

View File

@ -0,0 +1 @@
Add proper docstrings to enums that show in drivers docs.

View File

@ -443,7 +443,12 @@ Value
Driver Reference
****************
.. automodule:: redbot.core.drivers
.. autofunction:: redbot.core.drivers.get_driver
.. autoclass:: redbot.core.drivers.BackendType
:members:
.. autoclass:: redbot.core.drivers.ConfigCategory
:members:
Base Driver
@ -456,3 +461,7 @@ JSON Driver
.. autoclass:: redbot.core.drivers.JsonDriver
:members:
Postgres Driver
^^^^^^^^^^^^^^^
.. autoclass:: redbot.core.drivers.PostgresDriver
:members:

View File

@ -18,9 +18,13 @@ __all__ = [
class BackendType(enum.Enum):
"""Represents storage backend type."""
#: JSON storage backend.
JSON = "JSON"
#: Postgres storage backend.
POSTGRES = "Postgres"
# Dead drivrs below retained for error handling.
# Dead drivers below retained for error handling.
MONGOV1 = "MongoDB"
MONGO = "MongoDBV2"

View File

@ -6,11 +6,19 @@ __all__ = ["BaseDriver", "IdentifierData", "ConfigCategory"]
class ConfigCategory(str, enum.Enum):
"""Represents config category."""
#: Global category.
GLOBAL = "GLOBAL"
#: Guild category.
GUILD = "GUILD"
#: Channel category.
CHANNEL = "TEXTCHANNEL"
#: Role category.
ROLE = "ROLE"
#: User category.
USER = "USER"
#: Member category.
MEMBER = "MEMBER"
@classmethod