Skip to content

Commit

Permalink
release 1.11.0 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tieske committed Aug 18, 2021
1 parent c8f6cdc commit e3712f0
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h2>Examples</h2>
<div id="content">


<h2>Penlight Lua Libraries 1.10.0</h2>
<h2>Penlight Lua Libraries 1.11.0</h2>
<p>Penlight is a set of pure Lua libraries for making it easier to work with common tasks like iterating over directories, reading configuration files and the like. Provides functional operations on tables and sequences. Visit the <a href="https://github.com/lunarmodules/Penlight">GitHub project</a> to review the code or file issues. Skip to the <a href="manual/01-introduction.md.html#">introduction</a>.</p>

<h2>Libraries</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/libraries/pl.types.html
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ <h3>Raises:</h3>

<ul>
<li><code>nil</code></li>
<li>a table with out any items (key-value pairs or indexes)</li>
<li>a table without any items (key-value pairs or indexes)</li>
<li>a string with no content ("")</li>
<li>not a nil/table/string</li>
</ul>
Expand Down
13 changes: 7 additions & 6 deletions docs/libraries/pl.utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -1302,7 +1302,7 @@ <h2 class="section-header "><a name="Deprecation"></a>Deprecation </h2>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">func</span>
a callback with signature: <code>function(msg, trace)</code> both arguments are strings.
a callback with signature: <code>function(msg, trace)</code> both arguments are strings, the latter being optional.
</li>
</ul>

Expand All @@ -1317,7 +1317,7 @@ <h3>Usage:</h3>
<ul>
<pre class="example"><span class="comment">-- write to the Nginx logs with OpenResty
</span>utils.set_deprecation_func(<span class="keyword">function</span>(msg, trace)
ngx.log(ngx.WARN, msg, <span class="string">" "</span>, trace)
ngx.log(ngx.WARN, msg, (trace <span class="keyword">and</span> (<span class="string">" "</span> .. trace) <span class="keyword">or</span> <span class="keyword">nil</span>))
<span class="keyword">end</span>)

<span class="comment">-- disable deprecation warnings
Expand Down Expand Up @@ -1359,10 +1359,11 @@ <h3>Usage:</h3>
</span>
<span class="keyword">function</span> stringx.islower(str)
raise_deprecation {
source = <span class="string">"Penlight "</span> .. utils._VERSION, <span class="comment">-- optional
</span> message = <span class="string">"function 'islower' was renamed to 'is_lower'"</span> <span class="comment">-- required
</span> version_removed = <span class="string">"2.0.0"</span>, <span class="comment">-- optional
</span> deprecated_after = <span class="string">"1.2.3"</span>, <span class="comment">-- optional
source = <span class="string">"Penlight "</span> .. utils._VERSION, <span class="comment">-- optional
</span> message = <span class="string">"function 'islower' was renamed to 'is_lower'"</span>, <span class="comment">-- required
</span> version_removed = <span class="string">"2.0.0"</span>, <span class="comment">-- optional
</span> deprecated_after = <span class="string">"1.2.3"</span>, <span class="comment">-- optional
</span> no_trace = <span class="keyword">true</span>, <span class="comment">-- optional
</span> }
<span class="keyword">return</span> stringx.is_lower(str)
<span class="keyword">end</span>
Expand Down

0 comments on commit e3712f0

Please sign in to comment.