Equality docs

docs/docs_equality.rst

@@ -0,0 +1,20 @@
+.. include:: ./vars.rst
+
+Equality
+========
+
+The Equality class is used to see if two objects are equal, based on ``object_1.id === object_2.id``.
+
+If any class in Discord extends equality, it means you should never the default equality operands (``==`` & ``===``) as they could potentially be different instances and therefore appear not to be equal. Instead, use ``equalityObject.equals()`` as shown below.
+
+Functions
+---------
+
+--------
+
+equals(object)
+~~~~~~~~~~~~~~
+
+Returns true if the specified object is the same as this one.
+
+- **object** - Any `object` with an ``id`` property.

docs/index.rst

@@ -37,12 +37,14 @@ Contents:
    docs_server
    docs_user
    docs_message
+   docs_invite
    
 .. toctree::
    :maxdepth: 2
    :caption: Util Documentation
 
    docs_cache
+   docs_equality
 
 
 Indices and tables

docs/vars.rst

@@ -8,5 +8,7 @@
 .. _VoiceChannel : ./docs_voicechannel.html
 .. _PMChannel : ./docs_pmchannel.html
 .. _Message : ./docs_message.html
+.. _Invite : ./docs_invite.html
+.. _Equality : ./docs_equality.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