taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Add more explicit documentation for PrettyWeather's optional attributes

Browse Source
This commit is contained in:
Chris Cummer 2018-06-02 06:05:38 -07:00
parent c1f9c7bbfb
commit 052a115121
4 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
_site/content/posts/modules/prettyweather.md
View File

@ -43,7 +43,8 @@ None.
### Attributes
`city` <br />
_Optional_. <br />
_Optional_. It will grab the current location from your IP address if
omitted.<br />
Values: The name of any city supported by [Wttr.in](http://wttr.in).
`enabled` <br />
@ -58,6 +59,6 @@ How often, in seconds, this module will update its data. <br />
Values: A positive integer, `0..n`.
`unit` <br />
_Optional_. <br />
_Optional_. It will use metric if you are out of US and imperial for US.<br />
The temperature scale in which to display temperature values. <br />
Values: `F` for Fahrenheit, `C` for Celcius.

5
docs/index.xml
View File

@ -21,9 +21,10 @@
Displays weather information as ASCII art from Wttr.in.
Source Code wtf/prettyweather/ Required ENV Variables None.
Keyboard Commands None.
Configuration prettyweather:enabled:truecity:&amp;#34;tehran&amp;#34;position:top:3left:5height:1width:1refreshInterval:300unit:&amp;#34;c&amp;#34; Attributes city Optional. Values: The name of any city supported by Wttr.in.
Configuration prettyweather:enabled:truecity:&amp;#34;tehran&amp;#34;position:top:3left:5height:1width:1refreshInterval:300unit:&amp;#34;c&amp;#34; Attributes city Optional. It will grab the current location from your IP address if omitted.
Values: The name of any city supported by Wttr.in.
enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description>
position Defines where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item>
<item>

5
docs/posts/index.xml
View File

@ -21,9 +21,10 @@
Displays weather information as ASCII art from Wttr.in.
Source Code wtf/prettyweather/ Required ENV Variables None.
Keyboard Commands None.
Configuration prettyweather:enabled:truecity:&amp;#34;tehran&amp;#34;position:top:3left:5height:1width:1refreshInterval:300unit:&amp;#34;c&amp;#34; Attributes city Optional. Values: The name of any city supported by Wttr.in.
Configuration prettyweather:enabled:truecity:&amp;#34;tehran&amp;#34;position:top:3left:5height:1width:1refreshInterval:300unit:&amp;#34;c&amp;#34; Attributes city Optional. It will grab the current location from your IP address if omitted.
Values: The name of any city supported by Wttr.in.
enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description>
position Defines where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item>
<item>

5
docs/posts/modules/prettyweather/index.html
View File

@ -142,7 +142,8 @@
<h3 id="attributes">Attributes</h3>
<p><code>city</code> <br />
<em>Optional</em>. <br />
<em>Optional</em>. It will grab the current location from your IP address if
omitted.<br />
Values: The name of any city supported by <a href="http://wttr.in">Wttr.in</a>.</p>
<p><code>enabled</code> <br />
@ -157,7 +158,7 @@ How often, in seconds, this module will update its data. <br />
Values: A positive integer, <code>0..n</code>.</p>
<p><code>unit</code> <br />
<em>Optional</em>. <br />
<em>Optional</em>. It will use metric if you are out of US and imperial for US.<br />
The temperature scale in which to display temperature values. <br />
Values: <code>F</code> for Fahrenheit, <code>C</code> for Celcius.</p>