Skip to content

Commit

Permalink
Documentation: fix lfs, stevedonovan and orbit broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
jlaurens committed Jun 3, 2024
1 parent 767e9ba commit b03f56b
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 21 deletions.
16 changes: 8 additions & 8 deletions docs/libraries/pl.path.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h1>Module <code>pl.path</code></h1>
is Windows paths to allow both forward and backward slashes (since Lua
also accepts those)</p>

<p> Dependencies: <a href="../libraries/pl.utils.html#">pl.utils</a>, <a href="http://stevedonovan.github.io/lua-stdlibs/lfs.html">lfs</a></p>
<p> Dependencies: <a href="../libraries/pl.utils.html#">pl.utils</a>, <a href="https://lunarmodules.github.io/luafilesystem/manual.html">lfs</a></p>


<h2><a href="#Functions">Functions</a></h2>
Expand Down Expand Up @@ -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://keplerproject.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.dir</code></a>
Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.dir</code></a>



Expand All @@ -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://keplerproject.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.mkdir</code></a>
Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.mkdir</code></a>



Expand All @@ -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://keplerproject.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.rmdir</code></a>
Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.rmdir</code></a>



Expand All @@ -324,7 +324,7 @@ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
</dt>
<dd>
Gets attributes.
Implicit link to <a href="https://keplerproject.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.attributes</code></a>
Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.attributes</code></a>



Expand All @@ -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://keplerproject.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.currentdir</code></a>
Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.currentdir</code></a>



Expand All @@ -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://keplerproject.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.symlinkattributes</code></a>
Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.symlinkattributes</code></a>



Expand All @@ -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://keplerproject.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.chdir</code></a>
Implicit link to <a href="https://lunarmodules.github.io/luafilesystem/manual.html#reference"><code>luafilesystem.chdir</code></a>



Expand Down
3 changes: 1 addition & 2 deletions docs/manual/01-introduction.md.html
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,7 @@ <h3>Purpose</h3>
perverse, this matches the intended use better.</p>

<p>The only important external dependence of Penlight is
<a href="http://keplerproject.github.com/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
<a href="https://lunarmodules.github.io/luafilesystem/manual.html">LuaFileSystem</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
shell commands.)</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/04-paths.md.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ <h3>Directory Operations</h3>
functions in the Python <code>fnmatch</code> module. <code>getdirectories</code> will return all
directories contained in a directory, and <code>getfiles</code> will return all files in a
directory which match a shell pattern. These functions return the files as a
table, unlike <a href="http://stevedonovan.github.io/lua-stdlibs/lfs.html#dir">lfs.dir</a> which returns an iterator.)</p>
table, unlike <a href="https://lunarmodules.github.io/luafilesystem/manual.html#dir">lfs.dir</a> which returns an iterator.)</p>

<p><a href="../libraries/pl.dir.html#makepath">dir.makepath</a> can create a full path, creating subdirectories as necessary;
<code>rmtree</code> is the Nuclear Option of file deleting functions, since it will
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/06-data.md.html
Original file line number Diff line number Diff line change
Expand Up @@ -1264,7 +1264,7 @@ <h4>Parsing and Working with Configuration Files</h4>
<h4>Generating XML with 'xmlification'</h4>

<p>This feature is inspired by the <code>htmlify</code> function used by
<a href="http://keplerproject.github.com/orbit/">Orbit</a> to simplify HTML generation,
<a href="http://keplerproject.github.io/orbit/">Orbit</a> to simplify HTML generation,
except that no function environment magic is used; the <code>tags</code> function returns a
set of <em>constructors</em> for elements of the given tag names.</p>

Expand Down
2 changes: 1 addition & 1 deletion docs_topics/01-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ the order, so that the function is passed the value and then the key. Although
perverse, this matches the intended use better.

The only important external dependence of Penlight is
[LuaFileSystem](http://keplerproject.github.com/luafilesystem/manual.html)
[LuaFileSystem](http://lunarmodules.github.com/luafilesystem/manual.html)
(`lfs`), and if you want `dir.copyfile` to work cleanly on Windows, you will need
either [alien](http://alien.luaforge.net/) or be using
[LuaJIT](http://luajit.org) as well. (The fallback is to call the equivalent
Expand Down
2 changes: 1 addition & 1 deletion docs_topics/06-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -960,7 +960,7 @@ Getting the names of the providers per-country is straightforward:
#### Generating XML with 'xmlification'

This feature is inspired by the `htmlify` function used by
[Orbit](http://keplerproject.github.com/orbit/) to simplify HTML generation,
[Orbit](http://keplerproject.github.io/orbit/) to simplify HTML generation,
except that no function environment magic is used; the `tags` function returns a
set of _constructors_ for elements of the given tag names.

Expand Down
14 changes: 7 additions & 7 deletions lua/pl/path.lua
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ local function err_func(name, param, err, code)
end

--- Lua iterator over the entries of a given directory.
-- Implicit link to [`luafilesystem.dir`](https://keplerproject.github.io/luafilesystem/manual.html#reference)
-- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#dir)
-- @function dir
path.dir = lfs.dir

--- Creates a directory.
-- Implicit link to [`luafilesystem.mkdir`](https://keplerproject.github.io/luafilesystem/manual.html#reference)
-- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#mkdir)
-- @function mkdir
path.mkdir = function(d)
local ok, err, code = lfs.mkdir(d)
Expand All @@ -61,7 +61,7 @@ path.mkdir = function(d)
end

--- Removes a directory.
-- Implicit link to [`luafilesystem.rmdir`](https://keplerproject.github.io/luafilesystem/manual.html#reference)
-- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#rmdir)
-- @function rmdir
path.rmdir = function(d)
local ok, err, code = lfs.rmdir(d)
Expand All @@ -72,7 +72,7 @@ path.rmdir = function(d)
end

--- Gets attributes.
-- Implicit link to [`luafilesystem.attributes`](https://keplerproject.github.io/luafilesystem/manual.html#reference)
-- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#attributes)
-- @function attrib
path.attrib = function(d, r)
local ok, err, code = attrib(d, r)
Expand All @@ -83,7 +83,7 @@ path.attrib = function(d, r)
end

--- Get the working directory.
-- Implicit link to [`luafilesystem.currentdir`](https://keplerproject.github.io/luafilesystem/manual.html#reference)
-- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#currentdir)
-- @function currentdir
path.currentdir = function()
local ok, err, code = currentdir()
Expand All @@ -94,7 +94,7 @@ path.currentdir = function()
end

--- Gets symlink attributes.
-- Implicit link to [`luafilesystem.symlinkattributes`](https://keplerproject.github.io/luafilesystem/manual.html#reference)
-- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#symlinkattributes)
-- @function link_attrib
path.link_attrib = function(d, r)
local ok, err, code = link_attrib(d, r)
Expand All @@ -107,7 +107,7 @@ end
--- 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 [`luafilesystem.chdir`](https://keplerproject.github.io/luafilesystem/manual.html#reference)
-- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#chdir)
-- @function chdir
path.chdir = function(d)
local ok, err, code = lfs.chdir(d)
Expand Down

0 comments on commit b03f56b

Please sign in to comment.