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

Add a note about logging writing to file even if widget is disabled

This commit is contained in:
Chris Cummer 2018-06-19 07:07:45 -07:00
parent 2d6271650b
commit a0f820e205
4 changed files with 10 additions and 4 deletions

View File

@ -44,6 +44,10 @@ logger:
`enabled` <br /> `enabled` <br />
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 />
**Note:** If you're using logging and logging is _disabled_, your logs
will still be written to file, the widget just won't be shown onscreen.
If you have `logger.Log` calls in your code, regardless of this setting,
they will be written out. <br />
Values: `true`, `false`. Values: `true`, `false`.
`position` <br /> `position` <br />

View File

@ -21,8 +21,7 @@
To log to this file in your own modules: To log to this file in your own modules:
require &amp;#34;github.com/senorprogrammer/wtf/logger&amp;#34; logger.Log(&amp;#34;This is a log entry&amp;#34;) Source Code wtf/logger/ Required ENV Variables None. require &amp;#34;github.com/senorprogrammer/wtf/logger&amp;#34; logger.Log(&amp;#34;This is a log entry&amp;#34;) Source Code wtf/logger/ Required ENV Variables None.
Keyboard Commands Arrow keys scroll through the log file. Keyboard Commands Arrow keys scroll through the log file.
Configuration logger:enabled:trueposition:top:5left:4height:2width:1refreshInterval:1 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. Configuration logger:enabled:trueposition:top:5left:4height:2width:1refreshInterval:1 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Note: If you&amp;rsquo;re using logging and logging is disabled, your logs will still be written to file, the widget just won&amp;rsquo;t be shown onscreen.</description>
position Defines where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item> </item>
<item> <item>

View File

@ -21,8 +21,7 @@
To log to this file in your own modules: To log to this file in your own modules:
require &amp;#34;github.com/senorprogrammer/wtf/logger&amp;#34; logger.Log(&amp;#34;This is a log entry&amp;#34;) Source Code wtf/logger/ Required ENV Variables None. require &amp;#34;github.com/senorprogrammer/wtf/logger&amp;#34; logger.Log(&amp;#34;This is a log entry&amp;#34;) Source Code wtf/logger/ Required ENV Variables None.
Keyboard Commands Arrow keys scroll through the log file. Keyboard Commands Arrow keys scroll through the log file.
Configuration logger:enabled:trueposition:top:5left:4height:2width:1refreshInterval:1 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. Configuration logger:enabled:trueposition:top:5left:4height:2width:1refreshInterval:1 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Note: If you&amp;rsquo;re using logging and logging is disabled, your logs will still be written to file, the widget just won&amp;rsquo;t be shown onscreen.</description>
position Defines where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item> </item>
<item> <item>

View File

@ -148,6 +148,10 @@
<p><code>enabled</code> <br /> <p><code>enabled</code> <br />
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 />
<strong>Note:</strong> If you&rsquo;re using logging and logging is <em>disabled</em>, your logs
will still be written to file, the widget just won&rsquo;t be shown onscreen.
If you have <code>logger.Log</code> calls in your code, regardless of this setting,
they will be written out. <br />
Values: <code>true</code>, <code>false</code>.</p> Values: <code>true</code>, <code>false</code>.</p>
<p><code>position</code> <br /> <p><code>position</code> <br />