From ab5f0f8b7e720508f083358cd7322bfa3e467abc Mon Sep 17 00:00:00 2001 From: hydrabolt Date: Wed, 30 Sep 2015 18:31:50 +0100 Subject: [PATCH] Last of most of the documentation! --- docs/docs_invite.rst | 64 ++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + docs/vars.rst | 2 +- 3 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 docs/docs_invite.rst diff --git a/docs/docs_invite.rst b/docs/docs_invite.rst new file mode 100644 index 000000000..4c1688b1e --- /dev/null +++ b/docs/docs_invite.rst @@ -0,0 +1,64 @@ +.. include:: ./vars.rst + +Invite Documentation +==================== + +The Invite Class is used to represent data about an Invite. + +Attributes +---------- + +max_age +~~~~~~~ + +A `Number` in minutes for how long the Invite should be valid for. E.g. a value of ``3600`` is equal to 30 minutes. + +code +~~~~ + +`String` an alphanumeric code for the Invite. + +revoked +~~~~~~~ + +`Boolean` that dictates whether the Invite has been cancelled or not + +created_at +~~~~~~~~~~ + +A unix timestamp as a `Number` which is the time that the invite was created. + +temporary +~~~~~~~~~ + +`Boolean` that dictates whether the invite is temporary. + +uses +~~~~ + +`Number` the number of uses of the Invite, a value of ``0`` is none. + +max_uses +~~~~~~~~ + +`Number` that is the maximum amount of uses of the invite, ``0`` is unlimited. + +inviter +~~~~~~~ + +The User_ that created the invite. + +xkcd +~~~~ + +`Boolean` that is true if the invite should be human-readable. + +channel +~~~~~~~ + +The Channel_ that the invite is inviting to. + +URL +~~~ + +A `String` that generates a clickable link to the invite. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index ff7a59144..34e8f71a9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,6 +36,7 @@ Contents: docs_channel docs_pmchannel docs_message + docs_invite diff --git a/docs/vars.rst b/docs/vars.rst index 523c83d2d..ad4b9720a 100644 --- a/docs/vars.rst +++ b/docs/vars.rst @@ -5,7 +5,7 @@ .. _Channel : ./docs_channel.html .. _Message : ./docs_message.html .. _PMChannel : ./docs_pmchannel.html -.. _Invite : #invite +.. _Invite : ./docs_invite.html .. _Channel Resolvable : ./docs_resolvable.html#channel-resolvable .. _Invite Resolvable : ./docs_resolvable.html#invite-resolvable .. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise \ No newline at end of file