[hare] The Hare programming language
git clone https://git.torresjrjr.com/hare.git
Log | Files | Refs | README | LICENSE

commit 07609fd9d7bdbf0390eb8a4db46973ae7cdd6954
parent 38f1231600285172e4b71d8f966f217dee120fac
Author: Sebastian <sebastian@sebsite.pw>
Date:   Sat, 28 Oct 2023 02:34:31 -0400

hare-doc(5): document trailing :: for modules

Signed-off-by: Sebastian <sebastian@sebsite.pw>

Mdocs/hare-doc.5.scd | 7++++---
1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/docs/hare-doc.5.scd b/docs/hare-doc.5.scd @@ -14,7 +14,8 @@ Text may be written normally, broken into several lines to conform to the 80-column limit. To begin a new paragraph, insert an empty line. References to other declarations and modules may be written in brackets, like -this: [[os::stdout]]. +this: [[os::stdout]]. References to modules should include a trailing :: in the +identifier: [[os::exec::]]. A bulleted list can be started by opening a line with "-", optionally preceded by a space. Each line opened like this begins a new list item. To complete the @@ -33,7 +34,7 @@ present. // Foos the bars. See also [[foobar]]. // // If you instead want to bar the foos, use one of the functions in -// [[bar::foo]]. +// [[bar::foo::]]. // // - First, the bars are obtained. // - They are then fooed. @@ -55,7 +56,7 @@ content from its original textual representation: - Multiple code samples separated by empty lines should be collapsed into one code sample, so the empty lines are moved into the code sample itself. -*hare::parse::doc* in the standard library handles all of this processing for +*hare::parse::doc::* in the standard library handles all of this processing for you. Parsers are permitted (and encouraged) to error out on invalid input, such as a