From 4f64fa6bbba97090cfc48ccbe3ae9d982e2da4bc Mon Sep 17 00:00:00 2001
From: hydrabolt <amishshah.2k@gmail.com>
Date: Tue, 27 Oct 2015 21:30:47 +0000
Subject: [PATCH] Permission documentation

---
 docs/docs_permissions.rst | 74 ++++++++++++++++++++++++++++++++++++++-
 docs/index.rst            |  1 +
 lib/ChannelPermissions.js |  4 +++
 src/ChannelPermissions.js |  4 +++
 4 files changed, 82 insertions(+), 1 deletion(-)

diff --git a/docs/docs_permissions.rst b/docs/docs_permissions.rst
index 35c36ed72..aceb560da 100644
--- a/docs/docs_permissions.rst
+++ b/docs/docs_permissions.rst
@@ -77,4 +77,76 @@ serialize()
 
 **Aliases** : *serialise()*
 
-To get a valid `Object` of the actual permissions of the object, just do `serverPermissions.serialise()` to get an object with the above mentioned permissions
\ No newline at end of file
+To get a valid `Object` of the actual permissions of the object, just do `serverPermissions.serialise()` to get an object with the above mentioned permissions
+
+ChannelPermissions
+------------------
+
+ChannelPermissions are based from a ServerPermissions object (although not actually extending them, none of the Permissions objects extend each other). It represents an override/overwrite of a server permission.
+
+Actual Permissions:
+~~~~~~~~~~~~~~~~~~~
+
+{
+	createInstantInvite,
+	manageRoles,
+	manageChannels,
+	readMessages,
+	sendMessages,
+	sendTTSMessages,
+	manageMessages,
+	embedLinks,
+	attachFiles,
+	readMessageHistory,
+	mentionEveryone,
+	voiceConnect,
+	voiceSpeak,
+	voiceMuteMembers,
+	voiceDeafenMembers,
+	voiceMoveMember,
+	voiceUseVoiceActivation
+}
+
+serialize()
+~~~~~~~~~~~
+
+**Aliases** : *serialise()*
+
+To get a valid `Object` of the actual permissions of the object, just do `channelPermissions.serialise()` to get an object with the above mentioned permissions
+
+EvaluatedPermissions
+--------------------
+
+EvaluatedPermissions represents the permissions of a user in a channel, taking into account all roles and overwrites active on them; an evaluation of their permissions.
+
+Actual Permissions:
+~~~~~~~~~~~~~~~~~~~
+
+EvaluatedPermissions has the same permissions as ChannelPermissions.
+
+{
+	createInstantInvite,
+	manageRoles,
+	manageChannels,
+	readMessages,
+	sendMessages,
+	sendTTSMessages,
+	manageMessages,
+	embedLinks,
+	attachFiles,
+	readMessageHistory,
+	mentionEveryone,
+	voiceConnect,
+	voiceSpeak,
+	voiceMuteMembers,
+	voiceDeafenMembers,
+	voiceMoveMember,
+	voiceUseVoiceActivation
+}
+
+serialize()
+~~~~~~~~~~~
+
+**Aliases** : *serialise()*
+
+To get a valid `Object` of the actual permissions of the object, just do `channelPermissions.serialise()` to get an object with the above mentioned permissions
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index 34e8f71a9..488a136cb 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -37,6 +37,7 @@ Contents:
    docs_pmchannel
    docs_message
    docs_invite
+   docs_permissions
 
 
 
diff --git a/lib/ChannelPermissions.js b/lib/ChannelPermissions.js
index 49c0c0c31..5bf808ff2 100644
--- a/lib/ChannelPermissions.js
+++ b/lib/ChannelPermissions.js
@@ -52,6 +52,10 @@ var ChannelPermissions = (function () {
 		};
 	};
 
+	ChannelPermissions.prototype.serialize = function serialize() {
+		return this.serialise();
+	};
+
 	ChannelPermissions.prototype.getBit = function getBit(x) {
 		if ((this.packed >>> 3 & 1) === 1) {
 			return true;
diff --git a/src/ChannelPermissions.js b/src/ChannelPermissions.js
index 7433ec0c6..3f8317ae2 100644
--- a/src/ChannelPermissions.js
+++ b/src/ChannelPermissions.js
@@ -45,6 +45,10 @@ class ChannelPermissions {
 			voiceUseVoiceActivation: this.voiceUseVoiceActivation
 		}
 	}
+	
+	serialize(){
+		return this.serialise();
+	}
 
 	get asAllowDisallow() {