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

wtfutil · Jun 19, 2018 · a0f820e · a0f820e
1 parent 2d62716
commit a0f820e
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 4 deletions.
diff --git a/_site/content/posts/modules/logger.md b/_site/content/posts/modules/logger.md
@@ -44,6 +44,10 @@ logger:
 
 `enabled` <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`.
 
 `position` <br />

diff --git a/docs/index.xml b/docs/index.xml
@@ -21,8 +21,7 @@
 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.
 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.
-position Defines where in the grid this module&amp;rsquo;s widget will be displayed.</description>
+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>
     </item>
 
     <item>

diff --git a/docs/posts/index.xml b/docs/posts/index.xml
@@ -21,8 +21,7 @@
 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.
 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.
-position Defines where in the grid this module&amp;rsquo;s widget will be displayed.</description>
+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>
     </item>
 
     <item>

diff --git a/docs/posts/modules/logger/index.html b/docs/posts/modules/logger/index.html
@@ -148,6 +148,10 @@ <h3 id="attributes">Attributes</h3>
 
 <p><code>enabled</code> <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>
 
 <p><code>position</code> <br />