feat(docs): docs for cache and member

This commit is contained in:
grey-cat-1908 2022-05-25 10:14:26 +03:00
parent 10e0bd1830
commit 95c618bbe1
4 changed files with 60 additions and 6 deletions

19
docs/source/cache.rst Normal file
View file

@ -0,0 +1,19 @@
.. currentmodule:: melisa
Melisa Cache
=============
Cache
-------
AutoCacheModels
~~~~~~~~~~~~~~~~~~
.. autoclass:: AutoCacheModels()
CacheManager
~~~~~~~~~~~~~
.. attributetable:: CacheManager
.. autoclass:: CacheManager()
:inherited-members:

View file

@ -7,6 +7,7 @@ Welcome to Melisa's documentation!
client client
models/index models/index
cache
Indices and tables Indices and tables

View file

@ -33,6 +33,24 @@ TextChannel
.. autoclass:: TextChannel() .. autoclass:: TextChannel()
:inherited-members: :inherited-members:
NoneTypedChannel
~~~~~~~~~~~~~~~~~~
.. attributetable:: NoneTypedChannel
.. autoclass:: NoneTypedChannel()
:inherited-members:
Member
------
GuildMember
~~~~~~~~~~~~~~~~~~
.. attributetable:: GuildMember
.. autoclass:: GuildMember()
:inherited-members:
Guild Guild
------ ------
@ -123,3 +141,19 @@ ThreadsList
.. autoclass:: ThreadsList() .. autoclass:: ThreadsList()
:inherited-members: :inherited-members:
Webhook
-------
WebhookType
~~~~~~~~~~~
.. autoclass:: WebhookType()
Webhook
~~~~~~~~~~~~~
.. attributetable:: Webhook
.. autoclass:: Webhook()
:inherited-members:

View file

@ -22,18 +22,18 @@ class WebhookType(IntEnum):
Attributes Attributes
---------- ----------
Incoming: INCOMING:
Incoming Webhooks can post messages to channels with a generated token Incoming Webhooks can post messages to channels with a generated token
Channel_Follower: CHANNEL_FOLLOWER:
Channel Follower Webhooks are internal webhooks used with Channel Following Channel Follower Webhooks are internal webhooks used with Channel Following
to post new messages into channels to post new messages into channels
Application: APPLICATION:
Application webhooks are webhooks used with Interactions Application webhooks are webhooks used with Interactions
""" """
Incoming = 1 INCOMING = 1
Channel_Follower = 2 CHANNEL_FOLLOWER = 2
Application = 3 APPLICATION = 3
def __int__(self): def __int__(self):
return self.value return self.value