diff --git a/docs/docs_channel.rst b/docs/docs_channel.rst index a0e64a5eb..659210cd2 100644 --- a/docs/docs_channel.rst +++ b/docs/docs_channel.rst @@ -10,6 +10,8 @@ The Channel class is the base class for all types of channel. Attributes ---------- +-------- + id ~~ diff --git a/docs/docs_client.rst b/docs/docs_client.rst index 73322cf8b..212e2098f 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -10,6 +10,8 @@ This page contains documentation on the `Discord.Client` class. This should be u Attributes ---------- +-------- + users ~~~~~ diff --git a/docs/docs_invite.rst b/docs/docs_invite.rst new file mode 100644 index 000000000..f6bd67615 --- /dev/null +++ b/docs/docs_invite.rst @@ -0,0 +1,66 @@ +.. include:: ./vars.rst + +Invite +====== + +Used to represent data of an invite. + +Attributes +---------- + +-------- + +maxAge +~~~~~~ + +`Number`, how long (in seconds) the invite has since creation before expiring. + +code +~~~~ + +`String`, the invite code. + +server +~~~~~~ + +The Server_ the invite is for. + +channel +~~~~~~~ + +The ServerChannel_ the invite is for. + +revoked +~~~~~~~ + +`Boolean`, whether the invite has been revoked or not. + +createdAt +~~~~~~~~~ + +`Number`, timestamp of when the invite was created. + +temporary +~~~~~~~~~ + +`Boolean`, whether the invite is temporary or not. + +uses +~~~~ + +`Number`, uses of the invite remaining. + +maxUses +~~~~~~~ + +`Number`, maximum uses of the invite. + +inviter +~~~~~~~ + +User_ who sent/created the invite. + +xkcd +~~~~ + +`Boolean`, whether the invite is intended to be easy to read and remember by a human. \ No newline at end of file diff --git a/docs/docs_message.rst b/docs/docs_message.rst index 553f3e088..938546f1d 100644 --- a/docs/docs_message.rst +++ b/docs/docs_message.rst @@ -10,6 +10,8 @@ A Message object is used to represent the data of a message. Attributes ---------- +------- + channel ~~~~~~~ diff --git a/docs/docs_pmchannel.rst b/docs/docs_pmchannel.rst index e858434b9..a872ba95f 100644 --- a/docs/docs_pmchannel.rst +++ b/docs/docs_pmchannel.rst @@ -12,6 +12,8 @@ A PMChannel is a Private/Direct channel between the Client and another user. Attributes ---------- +-------- + messages ~~~~~~~~ diff --git a/docs/docs_server.rst b/docs/docs_server.rst index 7d06ff230..48ba46671 100644 --- a/docs/docs_server.rst +++ b/docs/docs_server.rst @@ -10,6 +10,8 @@ Stores information about a Discord Server. Attributes ---------- +-------- + client ~~~~~~ diff --git a/docs/docs_serverchannel.rst b/docs/docs_serverchannel.rst index 3bb692e92..2f5d34c96 100644 --- a/docs/docs_serverchannel.rst +++ b/docs/docs_serverchannel.rst @@ -10,6 +10,8 @@ A ServerChannel is a Channel_ that belongs to a Server_. Attributes ---------- +-------- + name ~~~~ diff --git a/docs/docs_textchannel.rst b/docs/docs_textchannel.rst index 4b3e0f864..fad2e9ec8 100644 --- a/docs/docs_textchannel.rst +++ b/docs/docs_textchannel.rst @@ -12,6 +12,8 @@ A text channel of a server. Attributes ---------- +-------- + topic ~~~~~ diff --git a/docs/docs_user.rst b/docs/docs_user.rst index ae7a2876c..25c805d58 100644 --- a/docs/docs_user.rst +++ b/docs/docs_user.rst @@ -10,6 +10,8 @@ Stores information about users. Attributes ---------- +-------- + client ~~~~~~