regenerated docs

the-allanc · Dec 7, 2019 · 3e8c07e · 3e8c07e
1 parent 1504c2c
commit 3e8c07e
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 12 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -73,7 +73,7 @@ <h2>Modules</h2>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2019-12-04 18:06:27 </i>
+<i style="float:right;">Last updated 2019-12-07 16:28:10 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/cairo_helpers.html b/docs/modules/cairo_helpers.html
@@ -578,7 +578,7 @@ <h3>Returns:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2019-12-04 18:06:27 </i>
+<i style="float:right;">Last updated 2019-12-07 16:28:10 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/data.html b/docs/modules/data.html
@@ -62,7 +62,7 @@ <h2><a href="#Functions">Functions</a></h2>
 	<td class="summary">Run a bulk conky_parse with collected strings from previous updates.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#eager_loader:get">eager_loader:get([remember=1], var)</a></td>
+	<td class="name" nowrap><a href="#eager_loader:get">eager_loader:get([remember=1], var[, ...])</a></td>
 	<td class="summary">Retrieve a conky_parse result.</td>
 	</tr>
 	<tr>
@@ -164,7 +164,7 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
 </dd>
     <dt>
     <a name = "eager_loader:get"></a>
-    <strong>eager_loader:get([remember=1], var)</strong>
+    <strong>eager_loader:get([remember=1], var[, ...])</strong>
     </dt>
     <dd>
     Retrieve a conky_parse result.
@@ -179,13 +179,29 @@ <h3>Parameters:</h3>
         </li>
         <li><span class="parameter">var</span>
             <span class="types"><span class="type">string</span></span>
-         string to be evaluated by conky_parse
+         string to be evaluated by <code>conky_parse</code>
+        </li>
+        <li><span class="parameter">...</span>
+         Additional arguments passed to <code>var:format(...)</code>
+         (<em>optional</em>)
         </li>
     </ul>
 
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">string</span></span>
+        result of <code>conky_parse(var)</code>
+    </ol>
 
 
 
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example">data.eager_loader:get(<span class="string">"$update"</span>)
+data.eager_loader:get(<span class="string">"${cpu cpu%s}"</span>, <span class="number">2</span>)  <span class="comment">-- usage of second CPU core
+</span>data.eager_loader:get(<span class="number">5</span>, <span class="string">"${fs_used_perc %s}"</span>, <span class="string">"/home"</span>)  <span class="comment">-- cached for 5 updates</span></pre>
+    </ul>
 
 </dd>
     <dt>
@@ -622,7 +638,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2019-12-04 18:06:27 </i>
+<i style="float:right;">Last updated 2019-12-07 16:28:10 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/polycore.html b/docs/modules/polycore.html
@@ -209,7 +209,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2019-12-04 18:06:27 </i>
+<i style="float:right;">Last updated 2019-12-07 16:28:10 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/util.html b/docs/modules/util.html
@@ -771,7 +771,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2019-12-04 18:06:27 </i>
+<i style="float:right;">Last updated 2019-12-07 16:28:10 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/widget.html b/docs/modules/widget.html
@@ -1290,8 +1290,8 @@ <h3>Parameters:</h3>
     <h2 class="section-header has-description"><a name="Class_Cpu"></a>Class Cpu </h2>
 
           <div class="section-description">
-          Polygon-style CPU usage & temperature tracking.
- Looks best for CPUs with 4 to 8 cores but also works for higher numbers
+          Polygon-style CPU usage & temperature indicator.
+ Looks best for CPUs with 4 to 8 cores but also works for higher numbers.
           </div>
     <dl class="function">
     <dt>
@@ -1334,7 +1334,7 @@ <h3>Parameters:</h3>
     <h2 class="section-header has-description"><a name="Class_CpuRound"></a>Class CpuRound </h2>
 
           <div class="section-description">
-          Round CPU usage & temperature tracking.
+          Round CPU usage & temperature indicator.
  Best suited for CPUs with high core counts.
           </div>
     <dl class="function">
@@ -1362,6 +1362,11 @@ <h3>Parameters:</h3>
             <span class="types"><span class="type">int</span></span>
          Max radius for core at 100%
         </li>
+        <li><span class="parameter">grid</span>
+            <span class="types"><span class="type">int</span></span>
+         Number of grid lines to draw in the background.
+         (<em>optional</em>)
+        </li>
         </li></ul>
     </ul>
 
@@ -1620,7 +1625,7 @@ <h3>Parameters:</h3>
 </div> <!-- id="main" -->
 <div id="about">
 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2019-12-04 18:06:27 </i>
+<i style="float:right;">Last updated 2019-12-07 16:28:10 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>