Add documentation for GitHub.enableStatus config option

wtfutil · Jul 15, 2018 · d34fd5b · d34fd5b
1 parent 46f4267
commit d34fd5b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/_site/content/posts/modules/github.md b/_site/content/posts/modules/github.md
@@ -61,6 +61,7 @@ wtf/github/
 ```yaml
 github:
   enabled: true
+  enableStatus: true
   position:
     top: 2
     left: 3
@@ -79,6 +80,11 @@ github:
 Determines whether or not this module is executed and if its data displayed onscreen. <br />
 Values: `true`, `false`.
 
+`enableStatus` <br />
+Display pull request mergeability status ('dirty', 'clean', 'unstable',
+'blocked').<br />
+Values: `true`, `false`.
+
 `position` <br />
 Defines where in the grid this module's widget will be displayed. <br />
 

diff --git a/docs/posts/modules/github/index.html b/docs/posts/modules/github/index.html
@@ -185,6 +185,7 @@ <h2 id="keyboard-commands">Keyboard Commands</h2>
 <h2 id="configuration">Configuration</h2>
 <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">github<span class="p">:</span><span class="w">
 </span><span class="w">  </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
+</span><span class="w">  </span>enableStatus<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
 </span><span class="w">  </span>position<span class="p">:</span><span class="w">
 </span><span class="w">    </span>top<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
 </span><span class="w">    </span>left<span class="p">:</span><span class="w"> </span><span class="m">3</span><span class="w">
@@ -201,6 +202,11 @@ <h3 id="attributes">Attributes</h3>
 Determines whether or not this module is executed and if its data displayed onscreen. <br />
 Values: <code>true</code>, <code>false</code>.</p>
 
+<p><code>enableStatus</code> <br />
+Display pull request mergeability status (&lsquo;dirty&rsquo;, &lsquo;clean&rsquo;, &lsquo;unstable&rsquo;,
+&lsquo;blocked&rsquo;).<br />
+Values: <code>true</code>, <code>false</code>.</p>
+
 <p><code>position</code> <br />
 Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p>