From 1c0f0289aa2ba0d5a19cd928bc7727e481f49be5 Mon Sep 17 00:00:00 2001
From: hydrabolt <amishshah.2k@gmail.com>
Date: Fri, 20 Nov 2015 16:54:39 +0000
Subject: [PATCH] Added user docs

---
 docs/docs_client.rst |  2 +-
 docs/docs_user.rst   | 71 ++++++++++++++++++++++++++++++++++++++++++++
 docs/index.rst       |  1 +
 docs/vars.rst        |  1 +
 4 files changed, 74 insertions(+), 1 deletion(-)
 create mode 100644 docs/docs_user.rst

diff --git a/docs/docs_client.rst b/docs/docs_client.rst
index 7e6b072f4..fad174937 100644
--- a/docs/docs_client.rst
+++ b/docs/docs_client.rst
@@ -3,7 +3,7 @@
 Client
 ======
 
-**extends EventEmitter_**
+**extends** EventEmitter_
 
 This page contains documentation on the `Discord.Client` class. This should be used when you want to start creating things with the API.
 
diff --git a/docs/docs_user.rst b/docs/docs_user.rst
new file mode 100644
index 000000000..f1ac9eb63
--- /dev/null
+++ b/docs/docs_user.rst
@@ -0,0 +1,71 @@
+.. include:: ./vars.rst
+
+User
+====
+
+**extends** Equality_
+
+Stores information about users.
+
+Attributes
+----------
+
+client
+~~~~~~
+
+The Client_ that created the user.
+
+username
+~~~~~~~~
+
+`String`, username of the User.
+
+discriminator
+~~~~~~~~~~~~~
+
+`Integer` from 0-9999, don't use this to identify users. Used to separate the user from the 9998 others that may have the same username. Made redundant by ``user.id``.
+
+id
+~~
+
+`String` (do not parse to an Integer, will become inaccurate). The ID of a user, never changes.
+
+avatar
+~~~~~~
+
+`String`, the ID/hash of a user's avatar. To get a path to their avatar, see ``user.avatarURL``.
+
+status
+~~~~~~
+
+The status of a user, `String`. Either ``online``, ``offline`` or ``idle``.
+
+gameID
+~~~~~~
+
+The ID of the game a user is playing, `Number`.
+
+typing
+~~~~~~
+
+`Object` containing the following values;
+
+.. code-block:: js
+
+	{
+		since : 1448038288519, //timestamp of when
+		channel : <Channel Object> // channel they are typing in.
+	}
+	
+avatarURL
+~~~~~~~~~
+
+A valid URL to the user's avatar if they have one, otherwise null.
+
+Functions
+---------
+
+mention()
+~~~~~~~~~
+
+Returns a valid string that can be sent in a message to mention the user. By default, ``user.toString()`` does this so by adding a user object to a string, e.g. ``user + ""``, their mention code will be retrieved.
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index 8d81b3959..b1d762cf4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -24,6 +24,7 @@ Contents:
    :caption: Documentation
 
    docs_client
+   docs_user
    
 .. toctree::
    :maxdepth: 2
diff --git a/docs/vars.rst b/docs/vars.rst
index 0728a1ea7..0f48aac42 100644
--- a/docs/vars.rst
+++ b/docs/vars.rst
@@ -1,4 +1,5 @@
 .. _Client : ./docs_client.html
 .. _Cache : ./docs_cache.html
+.. _User : ./docs_user.html
 .. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise
 .. _EventEmitter : https://nodejs.org/api/events.html#events_class_events_eventemitter
\ No newline at end of file