Skip to content

Commit e93af40

Browse files
committed
docs: Use short first paragraphs for module index.
LDoc uses the first paragraph of each modules doccomment as in the front page index. Put back the one liners we used to have. Signed-off-by: Gary V. Vaughan <gary@gnu.org>
1 parent 6eeb38e commit e93af40

File tree

5 files changed

+10
-0
lines changed

5 files changed

+10
-0
lines changed

lib/std/prototype/container.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
--[[--
2+
Container Prototype.
3+
24
This module supplies the root prototype object from which every other
35
object is descended. There are no classes as such, rather new objects
46
are created by cloning an existing object, and then changing or adding

lib/std/prototype/object.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
--[[--
2+
Object Prototype.
3+
24
This module provides a specialization of the @{prototype.container.prototype}
35
with the addition of object methods. In addition to the functionality
46
described here, object prototypes also have all the methods and

lib/std/prototype/set.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
--[[--
2+
Set Prototype.
3+
24
This module returns a table of set operators, as well as the prototype
35
for a Set container object.
46

lib/std/prototype/strbuf.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
--[[--
2+
StrBuf Prototype.
3+
24
Buffers are mutable by default, but being based on objects, they can
35
also be used in a functional style:
46

lib/std/prototype/trie.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
--[[--
2+
Trie Prototype.
3+
24
This module returns a table of trie operators, as well as the prototype
35
for a Trie container object.
46

0 commit comments

Comments
 (0)