Skip to content

Commit a26ca8d

Browse files
authored
Documentation: fix lfs, stevedonovan and orbit broken links (#478)
1 parent e2ea9b7 commit a26ca8d

File tree

7 files changed

+23
-23
lines changed

7 files changed

+23
-23
lines changed

docs_topics/01-introduction.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ the order, so that the function is passed the value and then the key. Although
4141
perverse, this matches the intended use better.
4242

4343
The only important external dependence of Penlight is
44-
[LuaFileSystem](http://keplerproject.github.com/luafilesystem/manual.html)
44+
[LuaFileSystem](https://lunarmodules.github.io/luafilesystem/manual.html)
4545
(`lfs`), and if you want `dir.copyfile` to work cleanly on Windows, you will need
46-
either [alien](http://alien.luaforge.net/) or be using
47-
[LuaJIT](http://luajit.org) as well. (The fallback is to call the equivalent
46+
either [alien](https://github.com/mascarenhas/alien) or be using
47+
[LuaJIT](https://luajit.org) as well. (The fallback is to call the equivalent
4848
shell commands.)
4949

5050
### To Inject or not to Inject?
@@ -311,7 +311,7 @@ upfront, since in general you won't know what values are needed.
311311

312312
Penlight is fully compatible with Lua 5.1, 5.2 and LuaJIT 2. To ensure this,
313313
`utils` also defines the global Lua 5.2
314-
[load](http://www.lua.org/work/doc/manual.html#pdf-load) function as `utils.load`
314+
[load](https://www.lua.org/work/doc/manual.html#pdf-load) function as `utils.load`
315315

316316
* the input (either a string or a function)
317317
* the source name used in debug information
@@ -483,7 +483,7 @@ if no `__tostring` method is explicitly defined.
483483
So `Alice = class(); Alice._name = 'Alice'` is exactly the same as `class.Alice()`.
484484

485485
This useful notation is borrowed from Hugo Etchegoyen's
486-
[classlib](http://lua-users.org/wiki/MultipleInheritanceClasses) which further
486+
[classlib](https://lua-users.org/wiki/MultipleInheritanceClasses) which further
487487
extends this concept to allow for multiple inheritance. Notice that the
488488
more convenient form puts the class name in the _current environment_! That is,
489489
you may use it safely within modules using the old-fashioned `module()`

docs_topics/02-arrays.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@ compulsory way to use Penlight table operations.
520520
Two-dimensional tables are of course easy to represent in Lua, for instance
521521
`{{1,2},{3,4}}` where we store rows as subtables and index like so `A[col][row]`.
522522
This is the common representation used by matrix libraries like
523-
[LuaMatrix](http://lua-users.org/wiki/LuaMatrix). `pl.array2d` does not provide
523+
[LuaMatrix](https://lua-users.org/wiki/LuaMatrix). `pl.array2d` does not provide
524524
matrix operations, since that is the job for a specialized library, but rather
525525
provides generalizations of the higher-level operations provided by `pl.tablex`
526526
for one-dimensional arrays.

docs_topics/03-strings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ metatable. But in your own scripts you can feel free to do this.
122122
### Another Style of Template
123123

124124
A new module is `template`, which is a version of Rici Lake's [Lua
125-
Preprocessor](http://lua-users.org/wiki/SlightlyLessSimpleLuaPreprocessor). This
125+
Preprocessor](https://lua-users.org/wiki/SlightlyLessSimpleLuaPreprocessor). This
126126
allows you to mix Lua code with your templates in a straightforward way. There
127127
are only two rules:
128128

docs_topics/05-dates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ NOTE: the Date module is deprecated
77
### Creating and Displaying Dates
88

99
The `Date` class provides a simplified way to work with [date and
10-
time](http://www.lua.org/pil/22.1.html) in Lua; it leans heavily on the functions
10+
time](https://www.lua.org/pil/22.1.html) in Lua; it leans heavily on the functions
1111
`os.date` and `os.time`.
1212

1313
A `Date` object can be constructed from a table, just like with `os.time`.

docs_topics/06-data.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ this data. In fact, these functions are available as methods; e.g.
353353
v = data.read('dat.txt'):flatten()
354354

355355
The data is also in exactly the right shape to be treated as matrices by
356-
[LuaMatrix](http://lua-users.org/wiki/LuaMatrix):
356+
[LuaMatrix](https://lua-users.org/wiki/LuaMatrix):
357357

358358
> matrix = require 'matrix'
359359
> m = matrix(data.read 'mat.txt')
@@ -775,7 +775,7 @@ specialized library.
775775

776776
#### Parsing and Pretty-Printing
777777

778-
The semi-standard XML parser in the Lua universe is [lua-expat](http://matthewwild.co.uk/projects/luaexpat/).
778+
The semi-standard XML parser in the Lua universe is [lua-expat](https://lunarmodules.github.io/luaexpat/).
779779
In particular,
780780
it has a function called `lxp.lom.parse` which will parse XML into the Lua Object
781781
Model (LOM) format. However, it does not provide a way to convert this data back
@@ -846,7 +846,7 @@ There is a fourth argument which is the _attribute indent_:
846846
#### Parsing and Working with Configuration Files
847847

848848
It's common to find configurations expressed with XML these days. It's
849-
straightforward to 'walk' the [LOM](http://matthewwild.co.uk/projects/luaexpat/lom.html)
849+
straightforward to 'walk' the [LOM](https://lunarmodules.github.io/luaexpat/lom.html)
850850
data and extract the data in the form you want:
851851

852852
require 'pl'
@@ -960,7 +960,7 @@ Getting the names of the providers per-country is straightforward:
960960
#### Generating XML with 'xmlification'
961961

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

@@ -1047,9 +1047,9 @@ extract values from it using a pattern.
10471047

10481048
A common use of this is parsing the XML result of API queries. The
10491049
[(undocumented and subsequently discontinued) Google Weather
1050-
API](http://blog.programmableweb.com/2010/02/08/googles-secret-weather-api/) is a
1050+
API](https://blog.programmableweb.com/2010/02/08/googles-secret-weather-api/) is a
10511051
good example. Grabbing the result of
1052-
`http://www.google.com/ig/api?weather=Johannesburg,ZA" we get something like
1052+
`https://www.google.com/ig/api?weather=Johannesburg,ZA" we get something like
10531053
this, after pretty-printing:
10541054

10551055
<xml_api_reply version='1'>

docs_topics/08-additional.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ array.
373373
Consider this implementation of the head utility from Mac OS X:
374374

375375
-- implements a BSD-style head
376-
-- (see http://www.manpagez.com/man/1/head/osx-10.3.php)
376+
-- (see https://www.manpagez.com/man/1/head/osx-10.3.php)
377377

378378
lapp = require ('pl.lapp')
379379

@@ -528,7 +528,7 @@ And here we can see the output of `test.lua`:
528528
### Simple Test Framework
529529

530530
`pl.test` was originally developed for the sole purpose of testing Penlight itself,
531-
but you may find it useful for your own applications. ([There are many other options](http://lua-users.org/wiki/UnitTesting).)
531+
but you may find it useful for your own applications. ([There are many other options](https://lua-users.org/wiki/UnitTesting).)
532532

533533
Most of the goodness is in `test.asserteq`. It uses `tablex.deepcompare` on its two arguments,
534534
and by default quits the test application with a non-zero exit code, and an informative

lua/pl/path.lua

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,12 @@ local function err_func(name, param, err, code)
4545
end
4646

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

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

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

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

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

9696
--- Gets symlink attributes.
97-
-- Implicit link to [`luafilesystem.symlinkattributes`](https://keplerproject.github.io/luafilesystem/manual.html#reference)
97+
-- Implicit link to [`luafilesystem.symlinkattributes`](https://lunarmodules.github.io/luafilesystem/manual.html#symlinkattributes)
9898
-- @function link_attrib
9999
path.link_attrib = function(d, r)
100100
local ok, err, code = link_attrib(d, r)
@@ -107,7 +107,7 @@ end
107107
--- Changes the working directory.
108108
-- On Windows, if a drive is specified, it also changes the current drive. If
109109
-- only specifying the drive, it will only switch drive, but not modify the path.
110-
-- Implicit link to [`luafilesystem.chdir`](https://keplerproject.github.io/luafilesystem/manual.html#reference)
110+
-- Implicit link to [`luafilesystem.chdir`](https://lunarmodules.github.io/luafilesystem/manual.html#chdir)
111111
-- @function chdir
112112
path.chdir = function(d)
113113
local ok, err, code = lfs.chdir(d)

0 commit comments

Comments
 (0)