1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

Add documentation for GitHub.enableStatus config option

This commit is contained in:
Chris Cummer 2018-07-14 17:59:53 -07:00
parent 46f42672e0
commit d34fd5b7c1
2 changed files with 12 additions and 0 deletions

View File

@ -61,6 +61,7 @@ wtf/github/
```yaml ```yaml
github: github:
enabled: true enabled: true
enableStatus: true
position: position:
top: 2 top: 2
left: 3 left: 3
@ -79,6 +80,11 @@ github:
Determines whether or not this module is executed and if its data displayed onscreen. <br /> Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`. Values: `true`, `false`.
`enableStatus` <br />
Display pull request mergeability status ('dirty', 'clean', 'unstable',
'blocked').<br />
Values: `true`, `false`.
`position` <br /> `position` <br />
Defines where in the grid this module's widget will be displayed. <br /> Defines where in the grid this module's widget will be displayed. <br />

View File

@ -185,6 +185,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="configuration">Configuration</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"> <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>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>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>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"> </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 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
Determines whether or not this module is executed and if its data displayed onscreen. <br /> Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p> 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 /> <p><code>position</code> <br />
Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p> Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p>