Dimscord v1.0.6: update docs

krisppurg · Sep 10, 2020 · 8a9391f · 8a9391f
1 parent 2591f72
commit 8a9391f
Show file tree

Hide file tree

Showing 13 changed files with 228 additions and 203 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ Why Dimscord?
  * What is Nim?
    * Nim is a statically-typed programming language (older than go and rust) that compiles to C/C++/JavaScript.
    It is similar to Python, easier to learn and it's flexible. [You can read it more in the official website for Nim.](https://nim-lang.org)
- * Why even use Nim for discord bots?
+ * Why use Nim for discord bots?
    * Since it's easier to learn, it's more faster than any other interpreted languages,
     which is beneficial, for larger discord bots, so they could run faster.
     [You can read the Nim FAQ here](https://nim-lang.org/faq.html)

diff --git a/dimscord.nimble b/dimscord.nimble
@@ -1,6 +1,6 @@
 # Package
 
-version       = "1.0.1"
+version       = "1.0.6"
 author        = "KrispPurg"
 description   = "A Discord Bot & REST Library for Nim."
 license       = "MIT"

diff --git a/docs/dimscord.html b/docs/dimscord.html
diff --git a/docs/dimscord/constants.html b/docs/dimscord/constants.html
@@ -254,8 +254,8 @@ <h1 class="title">dimscord/constants</h1>
     title="ptTier3 = 3"><wbr />pt<wbr />Tier3<span class="attachedType"></span></a></li>
   <li><a class="reference" href="#gatPlaying"
     title="gatPlaying = 0"><wbr />gat<wbr />Playing<span class="attachedType"></span></a></li>
-  <li><a class="reference" href="#gatSteaming"
-    title="gatSteaming = 1"><wbr />gat<wbr />Steaming<span class="attachedType"></span></a></li>
+  <li><a class="reference" href="#gatStreaming"
+    title="gatStreaming = 1"><wbr />gat<wbr />Streaming<span class="attachedType"></span></a></li>
   <li><a class="reference" href="#gatListening"
     title="gatListening = 2"><wbr />gat<wbr />Listening<span class="attachedType"></span></a></li>
   <li><a class="reference" href="#gatWatching"
@@ -1162,8 +1162,8 @@ <h1><a class="toc-backref" href="#10">Consts</a></h1>
 <a href="https://github.com/krisppurg/dimscord/edit/devel/dimscord/constants.nim#L135" class="link-seesrc" target="_blank" >Edit</a>
 
 </dd>
-<a id="gatSteaming"></a>
-<dt><pre><a href="constants.html#gatSteaming"><span class="Identifier">gatSteaming</span></a> <span class="Other">=</span> <span class="DecNumber">1</span></pre></dt>
+<a id="gatStreaming"></a>
+<dt><pre><a href="constants.html#gatStreaming"><span class="Identifier">gatStreaming</span></a> <span class="Other">=</span> <span class="DecNumber">1</span></pre></dt>
 <dd>
 
 
@@ -2173,7 +2173,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
       <div class="twelve-columns footer">
         <span class="nim-sprite"></span>
         <br/>
-        <small style="color: var(--hint);">Made with Nim. Generated: 2020-08-21 16:58:14 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2020-09-10 17:47:32 UTC</small>
       </div>
     </div>
   </div>

diff --git a/docs/dimscord/constants.idx b/docs/dimscord/constants.idx
@@ -117,7 +117,7 @@ ptTier1	dimscord/constants.html#ptTier1	constants: ptTier1
 ptTier2	dimscord/constants.html#ptTier2	constants: ptTier2	
 ptTier3	dimscord/constants.html#ptTier3	constants: ptTier3	
 gatPlaying	dimscord/constants.html#gatPlaying	constants: gatPlaying	
-gatSteaming	dimscord/constants.html#gatSteaming	constants: gatSteaming	
+gatStreaming	dimscord/constants.html#gatStreaming	constants: gatStreaming	
 gatListening	dimscord/constants.html#gatListening	constants: gatListening	
 gatWatching	dimscord/constants.html#gatWatching	constants: gatWatching	
 gatCustom	dimscord/constants.html#gatCustom	constants: gatCustom	

diff --git a/docs/dimscord/dispatch.html b/docs/dimscord/dispatch.html
@@ -149,7 +149,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
       <div class="twelve-columns footer">
         <span class="nim-sprite"></span>
         <br/>
-        <small style="color: var(--hint);">Made with Nim. Generated: 2020-08-21 16:58:21 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2020-09-10 17:47:38 UTC</small>
       </div>
     </div>
   </div>

diff --git a/docs/dimscord/gateway.html b/docs/dimscord/gateway.html
@@ -109,9 +109,12 @@ <h1 class="title">dimscord/gateway</h1>
       <li><a class="reference" href="#updateStatus%2CShard%2Cstring"
     title="updateStatus(s: Shard; game = none GameStatus; status = &quot;online&quot;; afk = false): owned(
     Future[void])"><wbr />update<wbr />Status<span class="attachedType"></span></a></li>
-  <li><a class="reference" href="#requestGuildMembers%2CShard%2Cseq%5Bstring%5D%2Cint%2Cstring%2Cstring%2Cseq%5Bstring%5D"
-    title="requestGuildMembers(s: Shard; guild_id: seq[string]; limit: int; query, nonce = &quot;&quot;;
-                    presences = false; user_ids: seq[string] = @[]): owned(Future[void])"><wbr />request<wbr />Guild<wbr />Members<span class="attachedType"></span></a></li>
+  <li><a class="reference" href="#resume%2CShard"
+    title="resume(s: Shard): owned(Future[void])"><wbr />resume<span class="attachedType"></span></a></li>
+  <li><a class="reference" href="#requestGuildMembers%2CShard%2C%2Cstring%2Cseq%5Bstring%5D"
+    title="requestGuildMembers(s: Shard; guild_id: string or seq[string]; limit = none int;
+                    query = none string; nonce = &quot;&quot;; presences = false;
+                    user_ids: seq[string] = @[]): owned(Future[void])"><wbr />request<wbr />Guild<wbr />Members<span class="attachedType"></span></a></li>
   <li><a class="reference" href="#voiceStateUpdate%2CShard%2Cstring"
     title="voiceStateUpdate(s: Shard; guild_id: string; channel_id = none string;
                  self_mute, self_deaf = false): owned(Future[void])"><wbr />voice<wbr />State<wbr />Update<span class="attachedType"></span></a></li>
@@ -155,24 +158,34 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
 
 Updates the shard's status.
 &nbsp;&nbsp;<a
-href="https://github.com/krisppurg/dimscord/tree/master/dimscord/gateway.nim#L105"
+href="https://github.com/krisppurg/dimscord/tree/master/dimscord/gateway.nim#L103"
 class="link-seesrc" target="_blank">Source</a>
-<a href="https://github.com/krisppurg/dimscord/edit/devel/dimscord/gateway.nim#L105" class="link-seesrc" target="_blank" >Edit</a>
+<a href="https://github.com/krisppurg/dimscord/edit/devel/dimscord/gateway.nim#L103" class="link-seesrc" target="_blank" >Edit</a>
 
 </dd>
-<a id="requestGuildMembers,Shard,seq[string],int,string,string,seq[string]"></a>
-<dt><pre><span class="Keyword">proc</span> <a href="#requestGuildMembers%2CShard%2Cseq%5Bstring%5D%2Cint%2Cstring%2Cstring%2Cseq%5Bstring%5D"><span class="Identifier">requestGuildMembers</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="objects.html#Shard"><span class="Identifier">Shard</span></a><span class="Other">;</span> <span class="Identifier">guild_id</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">limit</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span>
-                        <span class="Identifier">query</span><span class="Other">,</span> <span class="Identifier">nonce</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">presences</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span>
-                        <span class="Identifier">user_ids</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
-    <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span>
+<a id="resume,Shard"></a>
+<dt><pre><span class="Keyword">proc</span> <a href="#resume%2CShard"><span class="Identifier">resume</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="objects.html#Shard"><span class="Identifier">Shard</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">FutureError</span><span class="Other">]</span><span class="Other">,</span>
     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
 <dd>
 
+
+&nbsp;&nbsp;<a
+href="https://github.com/krisppurg/dimscord/tree/master/dimscord/gateway.nim#L158"
+class="link-seesrc" target="_blank">Source</a>
+<a href="https://github.com/krisppurg/dimscord/edit/devel/dimscord/gateway.nim#L158" class="link-seesrc" target="_blank" >Edit</a>
+
+</dd>
+<a id="requestGuildMembers,Shard,,string,seq[string]"></a>
+<dt><pre><span class="Keyword">proc</span> <a href="#requestGuildMembers%2CShard%2C%2Cstring%2Cseq%5Bstring%5D"><span class="Identifier">requestGuildMembers</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="objects.html#Shard"><span class="Identifier">Shard</span></a><span class="Other">;</span> <span class="Identifier">guild_id</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Keyword">or</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">limit</span> <span class="Other">=</span> <span class="Identifier">none</span> <span class="Identifier">int</span><span class="Other">;</span>
+                        <span class="Identifier">query</span> <span class="Other">=</span> <span class="Identifier">none</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">nonce</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">presences</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span>
+                        <span class="Identifier">user_ids</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
+<dd>
+
 Requests the offline members to a guild. (See: <a class="reference external" href="https://discord.com/developers/docs/topics/gateway#request-guild-members">https://discord.com/developers/docs/topics/gateway#request-guild-members</a>)
 &nbsp;&nbsp;<a
-href="https://github.com/krisppurg/dimscord/tree/master/dimscord/gateway.nim#L179"
+href="https://github.com/krisppurg/dimscord/tree/master/dimscord/gateway.nim#L177"
 class="link-seesrc" target="_blank">Source</a>
-<a href="https://github.com/krisppurg/dimscord/edit/devel/dimscord/gateway.nim#L179" class="link-seesrc" target="_blank" >Edit</a>
+<a href="https://github.com/krisppurg/dimscord/edit/devel/dimscord/gateway.nim#L177" class="link-seesrc" target="_blank" >Edit</a>
 
 </dd>
 <a id="voiceStateUpdate,Shard,string"></a>
@@ -264,7 +277,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
       <div class="twelve-columns footer">
         <span class="nim-sprite"></span>
         <br/>
-        <small style="color: var(--hint);">Made with Nim. Generated: 2020-08-21 16:58:22 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2020-09-10 17:47:38 UTC</small>
       </div>
     </div>
   </div>

diff --git a/docs/dimscord/gateway.idx b/docs/dimscord/gateway.idx
@@ -1,5 +1,6 @@
 updateStatus	dimscord/gateway.html#updateStatus,Shard,string	gateway: updateStatus(s: Shard; game = none GameStatus; status = &quot;online&quot;; afk = false): owned(\n    Future[void])	
-requestGuildMembers	dimscord/gateway.html#requestGuildMembers,Shard,seq[string],int,string,string,seq[string]	gateway: requestGuildMembers(s: Shard; guild_id: seq[string]; limit: int; query, nonce = &quot;&quot;;\n                    presences = false; user_ids: seq[string] = @[]): owned(Future[void])	
+resume	dimscord/gateway.html#resume,Shard	gateway: resume(s: Shard): owned(Future[void])	
+requestGuildMembers	dimscord/gateway.html#requestGuildMembers,Shard,,string,seq[string]	gateway: requestGuildMembers(s: Shard; guild_id: string or seq[string]; limit = none int;\n                    query = none string; nonce = &quot;&quot;; presences = false;\n                    user_ids: seq[string] = @[]): owned(Future[void])	
 voiceStateUpdate	dimscord/gateway.html#voiceStateUpdate,Shard,string	gateway: voiceStateUpdate(s: Shard; guild_id: string; channel_id = none string;\n                 self_mute, self_deaf = false): owned(Future[void])	
 disconnect	dimscord/gateway.html#disconnect,Shard	gateway: disconnect(s: Shard; should_reconnect = true): owned(Future[void])	
 endSession	dimscord/gateway.html#endSession,DiscordClient	gateway: endSession(cl: DiscordClient): owned(Future[void])	

diff --git a/docs/dimscord/misc.html b/docs/dimscord/misc.html
@@ -432,7 +432,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
       <div class="twelve-columns footer">
         <span class="nim-sprite"></span>
         <br/>
-        <small style="color: var(--hint);">Made with Nim. Generated: 2020-08-21 16:58:20 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2020-09-10 17:47:36 UTC</small>
       </div>
     </div>
   </div>