release 1.15.0 docs

Author: Tieske

docs/classes/pl.Map.html

@@ -33,7 +33,6 @@ <h1>Penlight</h1>
 
 <h2>Contents</h2>
 <ul>
-<li><a href="#Fields">Fields</a></li>
 <li><a href="#Methods">Methods</a></li>
 <li><a href="#Metamethods">Metamethods</a></li>
 </ul>
@@ -137,26 +136,23 @@ <h1>Class <code>pl.Map</code></h1>
 </p>
 
 
-<h2><a href="#Fields">Fields</a></h2>
+<h2><a href="#Methods">Methods</a></h2>
 <table class="function_list">
 	<tr>
-	<td class="name" nowrap><a href="#pl.map.keys">pl.map.keys</a></td>
-	<td class="summary">list of keys.</td>
+	<td class="name" nowrap><a href="#pl.map:keys">pl.map:keys ()</a></td>
+	<td class="summary">return a List of all keys.</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#pl.map.values">pl.map.values</a></td>
-	<td class="summary">list of values.</td>
+	<td class="name" nowrap><a href="#pl.map:values">pl.map:values ()</a></td>
+	<td class="summary">return a List of all values.</td>
 	</tr>
-</table>
-<h2><a href="#Methods">Methods</a></h2>
-<table class="function_list">
 	<tr>
 	<td class="name" nowrap><a href="#pl.map:iter">pl.map:iter ()</a></td>
 	<td class="summary">return an iterator over all key-value pairs.</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#pl.map:items">pl.map:items ()</a></td>
-	<td class="summary">return a List of all key-value pairs, sorted by the keys.</td>
+	<td class="summary">return a List of all key-value pairs, sorted by the keys in ascending order.</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#pl.map:setdefault">pl.map:setdefault (key, default)</a></td>
@@ -199,15 +195,15 @@ <h2><a href="#Metamethods">Metamethods</a></h2>
 <br/>
 
 
-    <h2 class="section-header "><a name="Fields"></a>Fields</h2>
+    <h2 class="section-header "><a name="Methods"></a>Methods</h2>
 
     <dl class="function">
     <dt>
-    <a name = "pl.map.keys"></a>
-    <strong>pl.map.keys</strong>
+    <a name = "pl.map:keys"></a>
+    <strong>pl.map:keys ()</strong>
     </dt>
     <dd>
-    list of keys.
+    return a List of all keys.
 
 
 
@@ -217,11 +213,11 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 
 </dd>
     <dt>
-    <a name = "pl.map.values"></a>
-    <strong>pl.map.values</strong>
+    <a name = "pl.map:values"></a>
+    <strong>pl.map:values ()</strong>
     </dt>
     <dd>
-    list of values.
+    return a List of all values.
 
 
 
@@ -230,10 +226,6 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 
 
 </dd>
-</dl>
-    <h2 class="section-header "><a name="Methods"></a>Methods</h2>
-
-    <dl class="function">
     <dt>
     <a name = "pl.map:iter"></a>
     <strong>pl.map:iter ()</strong>
@@ -253,7 +245,7 @@ <h2 class="section-header "><a name="Methods"></a>Methods</h2>
     <strong>pl.map:items ()</strong>
     </dt>
     <dd>
-    return a List of all key-value pairs, sorted by the keys.
+    return a List of all key-value pairs, sorted by the keys in ascending order.
 
 
 

docs/examples/seesubst.lua.html

@@ -150,7 +150,7 @@ <h2>seesubst.lua</h2>
 <span class="keyword">local</span> fun = sip.<span class="function-name">compile</span> <span class="string">'$v.$v.$v'</span>
 
 <span class="keyword">for</span> line <span class="keyword">in</span> stringx.<span class="function-name">lines</span>(s) <span class="keyword">do</span>
-    line = <span class="function-name">gsub</span>(line,<span class="string">'@see $p'</span>,<span class="keyword">function</span>(see,path)
+    <span class="keyword">local</span> newline = <span class="function-name">gsub</span>(line,<span class="string">'@see $p'</span>,<span class="keyword">function</span>(see,path)
         <span class="keyword">if</span> <span class="function-name">fun</span>(path,res) <span class="keyword">or</span> <span class="function-name">mod</span>(path,res) <span class="keyword">then</span>
             <span class="keyword">local</span> ret = (<span class="string">'[see %s](%s.%s.html'</span>):<span class="function-name">format</span>(path,res[<span class="number">1</span>],res[<span class="number">2</span>])
             <span class="keyword">if</span> res[<span class="number">3</span>] <span class="keyword">then</span>
@@ -160,7 +160,7 @@ <h2>seesubst.lua</h2>
             <span class="keyword">end</span>
         <span class="keyword">end</span>
     <span class="keyword">end</span>)
-    <span class="global">print</span>(line)
+    <span class="global">print</span>(newline)
 <span class="keyword">end</span></pre>
 
 

docs/examples/symbols.lua.html

@@ -252,12 +252,13 @@ <h2>symbols.lua</h2>
 </span>                <span class="keyword">local</span> res = {}
                 <span class="keyword">if</span> npe <span class="keyword">then</span> <span class="function-name">append</span>(res,npe) <span class="keyword">end</span>
                 <span class="keyword">for</span> val,count <span class="keyword">in</span> <span class="global">pairs</span>(<span class="function-name">count_map</span>(pe,equals)) <span class="keyword">do</span>
+                    <span class="keyword">local</span> nval = val
                     <span class="keyword">if</span> count &gt; <span class="number">1</span> <span class="keyword">then</span>
-                        <span class="keyword">if</span> op == <span class="string">'*'</span> <span class="keyword">then</span> val = val ^ count
-                        <span class="keyword">else</span> val = val * count
+                        <span class="keyword">if</span> op == <span class="string">'*'</span> <span class="keyword">then</span> nval = nval ^ count
+                        <span class="keyword">else</span> nval = nval * count
                         <span class="keyword">end</span>
                     <span class="keyword">end</span>
-                    <span class="function-name">append</span>(res,val)
+                    <span class="function-name">append</span>(res,nval)
                 <span class="keyword">end</span>
                 <span class="keyword">if</span> #res == <span class="number">1</span> <span class="keyword">then</span> <span class="keyword">return</span> res[<span class="number">1</span>] <span class="keyword">end</span>
                 <span class="keyword">return</span> <span class="function-name">PE</span>{op=op,<span class="function-name">unpack</span>(res)}

docs/index.html

@@ -114,7 +114,7 @@ <h2>Examples</h2>
 <div id="content">
 
 
-  <h2>Penlight Lua Libraries 1.14.0</h2>
+  <h2>Penlight Lua Libraries 1.15.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>

docs/libraries/pl.path.html

@@ -279,7 +279,7 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
     </dt>
     <dd>
     Lua iterator over the entries of a given directory.
- Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.dir</code></a>
+ Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#dir"><code>luafilesystem.dir</code></a>
 
 
 
@@ -294,7 +294,7 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
     </dt>
     <dd>
     Creates a directory.
- Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.mkdir</code></a>
+ Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#mkdir"><code>luafilesystem.mkdir</code></a>
 
 
 
@@ -309,7 +309,7 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
     </dt>
     <dd>
     Removes a directory.
- Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.rmdir</code></a>
+ Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#rmdir"><code>luafilesystem.rmdir</code></a>
 
 
 
@@ -324,7 +324,7 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
     </dt>
     <dd>
     Gets attributes.
- Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.attributes</code></a>
+ Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#attributes"><code>luafilesystem.attributes</code></a>
 
 
 
@@ -339,7 +339,7 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
     </dt>
     <dd>
     Get the working directory.
- Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.currentdir</code></a>
+ Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#currentdir"><code>luafilesystem.currentdir</code></a>
 
 
 
@@ -354,7 +354,7 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
     </dt>
     <dd>
     Gets symlink attributes.
- Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.symlinkattributes</code></a>
+ Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#symlinkattributes"><code>luafilesystem.symlinkattributes</code></a>
 
 
 
@@ -371,7 +371,7 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
     Changes the working directory.
  On Windows, if a drive is specified, it also changes the current drive. If
  only specifying the drive, it will only switch drive, but not modify the path.
- Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.chdir</code></a>
+ Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#chdir"><code>luafilesystem.chdir</code></a>
 
 
 
@@ -462,7 +462,7 @@ <h3>Parameters:</h3>
     <h3>Returns:</h3>
     <ol>
 
-        the file path if it exists (either as file, directory, socket, etc), nil otherwise
+        the file path if it exists (either as file, directory, socket, etc), false otherwise
     </ol>
 
 

docs/libraries/pl.utils.html

@@ -230,6 +230,10 @@ <h2><a href="#File_handling">File handling </a></h2>
 </table>
 <h2><a href="#OS_functions">OS functions </a></h2>
 <table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#execute">execute ()</a></td>
+	<td class="summary">Execute a shell command.</td>
+	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#executeex">executeex (cmd, bin)</a></td>
 	<td class="summary">execute a shell command and return the output.</td>
@@ -1105,6 +1109,21 @@ <h3>Raises:</h3>
     <h2 class="section-header "><a name="OS_functions"></a>OS functions </h2>
 
     <dl class="function">
+    <dt>
+    <a name = "execute"></a>
+    <strong>execute ()</strong>
+    </dt>
+    <dd>
+    Execute a shell command.
+ This function is a copy of <a href="../libraries/pl.compat.html#execute">compat.execute</a>.
+
+
+
+
+
+
+
+</dd>
     <dt>
     <a name = "executeex"></a>
     <strong>executeex (cmd, bin)</strong>
@@ -1147,7 +1166,7 @@ <h3>Returns:</h3>
     <dd>
     Quote and escape an argument of a command.
  Quotes a single (or list of) argument(s) of a command to be passed
- to <a href="https://www.lua.org/manual/5.4/manual.html#pdf-os.execute">os.execute</a>, <code>pl.utils.execute</code> or <a href="../libraries/pl.utils.html#executeex">pl.utils.executeex</a>.
+ to <a href="https://www.lua.org/manual/5.4/manual.html#pdf-os.execute">os.execute</a>, <a href="../libraries/pl.utils.html#execute">pl.utils.execute</a> or <a href="../libraries/pl.utils.html#executeex">pl.utils.executeex</a>.
 
 
     <h3>Parameters:</h3>

docs/manual/01-introduction.md.html

@@ -168,10 +168,10 @@ <h3>Purpose</h3>
 perverse, this matches the intended use better.</p>
 
 <p>The only important external dependence of Penlight is
-<a href="http://lunarmodules.github.io/luafilesystem/manual.html">LuaFileSystem</a>
+<a href="https://lunarmodules.github.io/luafilesystem/manual.html">LuaFileSystem</a>
 (<a href="http://stevedonovan.github.io/lua-stdlibs/lfs.html">lfs</a>), and if you want <a href="../libraries/pl.dir.html#copyfile">dir.copyfile</a> to work cleanly on Windows, you will need
-either <a href="http://alien.luaforge.net/">alien</a> or be using
-<a href="http://luajit.org">LuaJIT</a> as well. (The fallback is to call the equivalent
+either <a href="https://github.com/mascarenhas/alien">alien</a> or be using
+<a href="https://luajit.org">LuaJIT</a> as well. (The fallback is to call the equivalent
 shell commands.)</p>
 
 <p><a name="To_Inject_or_not_to_Inject_"></a></p>
@@ -490,7 +490,7 @@ <h3>Generally useful functions.</h3>
 
 <p>Penlight is fully compatible with Lua 5.1, 5.2 and LuaJIT 2. To ensure this,
 <a href="../libraries/pl.utils.html#">utils</a> also defines the global Lua 5.2
-<a href="http://www.lua.org/work/doc/manual.html#pdf-load">load</a> function as <code>utils.load</code></p>
+<a href="https://www.lua.org/work/doc/manual.html#pdf-load">load</a> function as <code>utils.load</code></p>
 
 <ul>
     <li>the input (either a string or a function)</li>
@@ -677,7 +677,7 @@ <h3>Simplifying Object-Oriented Programming in Lua</h3>
 <p>So <code>Alice = class(); Alice._name = &apos;Alice&apos;</code> is exactly the same as <code>class.Alice()</code>.</p>
 
 <p>This useful notation is borrowed from Hugo Etchegoyen's
-<a href="http://lua-users.org/wiki/MultipleInheritanceClasses">classlib</a> which further
+<a href="https://lua-users.org/wiki/MultipleInheritanceClasses">classlib</a> which further
 extends this concept to allow for multiple inheritance. Notice that the
 more convenient form puts the class name in the <em>current environment</em>! That is,
 you may use it safely within modules using the old-fashioned <code>module()</code>

docs/manual/02-arrays.md.html

@@ -745,7 +745,7 @@ <h3>Operations on two-dimensional tables</h3>
 <p>Two-dimensional tables are of course easy to represent in Lua, for instance
 <code>{{1,2},{3,4}}</code> where we store rows as subtables and index like so <code>A[col][row]</code>.
 This is the common representation used by matrix libraries like
-<a href="http://lua-users.org/wiki/LuaMatrix">LuaMatrix</a>. <a href="../libraries/pl.array2d.html#">pl.array2d</a> does not provide
+<a href="https://lua-users.org/wiki/LuaMatrix">LuaMatrix</a>. <a href="../libraries/pl.array2d.html#">pl.array2d</a> does not provide
 matrix operations, since that is the job for a specialized library, but rather
 provides generalizations of the higher-level operations provided by <a href="../libraries/pl.tablex.html#">pl.tablex</a>
 for one-dimensional arrays.</p>

docs/manual/03-strings.md.html

@@ -263,7 +263,7 @@ <h3>String Templates</h3>
 <p><a name="Another_Style_of_Template"></a></p>
 <h3>Another Style of Template</h3>
 
-<p>A new module is <a href="../libraries/pl.template.html#">template</a>, which is a version of Rici Lake's <a href="http://lua-users.org/wiki/SlightlyLessSimpleLuaPreprocessor">Lua
+<p>A new module is <a href="../libraries/pl.template.html#">template</a>, which is a version of Rici Lake's <a href="https://lua-users.org/wiki/SlightlyLessSimpleLuaPreprocessor">Lua
 Preprocessor</a>.  This
 allows you to mix Lua code with your templates in a straightforward way. There
 are only two rules:</p>

docs/manual/05-dates.md.html

@@ -127,7 +127,7 @@ <h2>Date and Time</h2>
 <p><a name="Creating_and_Displaying_Dates"></a></p>
 <h3>Creating and Displaying Dates</h3>
 
-<p>The <a href="../classes/pl.Date.html#">Date</a> class provides a simplified way to work with <a href="http://www.lua.org/pil/22.1.html">date and
+<p>The <a href="../classes/pl.Date.html#">Date</a> class provides a simplified way to work with <a href="https://www.lua.org/pil/22.1.html">date and
 time</a> in Lua; it leans heavily on the functions
 <a href="https://www.lua.org/manual/5.4/manual.html#pdf-os.date">os.date</a> and <a href="https://www.lua.org/manual/5.4/manual.html#pdf-os.time">os.time</a>.</p>