aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorCalvin Rose <calsrose@gmail.com>2022-10-12 19:35:01 -0500
committerCalvin Rose <calsrose@gmail.com>2022-10-12 19:35:01 -0500
commit0529f50195e89f7d7018f7732dd8abeae21e3e1d (patch)
treee5ec3e77f30eafde1d8d633ae42597ca42b25979 /doc
parentAdd randgen doc page. (diff)
Update docs.
Diffstat (limited to 'doc')
-rw-r--r--doc/argparse.mdz2
-rw-r--r--doc/data.mdz4
-rw-r--r--doc/formatting.mdz2
-rw-r--r--doc/generators.mdz2
-rw-r--r--doc/htmlgen.mdz2
-rw-r--r--doc/http.mdz2
-rw-r--r--doc/index.mdz2
-rw-r--r--doc/message-protocol.mdz2
-rw-r--r--doc/misc.mdz2
-rw-r--r--doc/networked-repl.mdz2
-rw-r--r--doc/path.mdz8
-rw-r--r--doc/randgen.mdz8
-rw-r--r--doc/regex.mdz4
-rw-r--r--doc/rpc-protocol.mdz2
-rw-r--r--doc/temple.mdz2
-rw-r--r--doc/test.mdz2
16 files changed, 25 insertions, 23 deletions
diff --git a/doc/argparse.mdz b/doc/argparse.mdz
index 0f3d0a6..bb97e7b 100644
--- a/doc/argparse.mdz
+++ b/doc/argparse.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 6}
+ :order 0}
---
A moderately opinionated argument parser for
diff --git a/doc/data.mdz b/doc/data.mdz
index 5dceae1..da0302a 100644
--- a/doc/data.mdz
+++ b/doc/data.mdz
@@ -2,7 +2,7 @@
:author "Caleb Figgers"
:license "MIT"
:template "mdzdoc/main.html"
- :order 0}
+ :order 1}
---
@link[https://clojure.org/]{Clojure} contains a very useful core library (or "namespace" in Clojure parlance) called @link[https://clojure.github.io/clojure/clojure.data-api.html]{clojure.data} (@link[https://github.com/clojure/clojure/blob/51c6d7a70912a8f65e81a8e11ae6f56c94920725/src/clj/clojure/data.clj]{source}). It contains one "exported" function: @code`clojure.data/diff`. This addition to spork, @code`data.janet`, should exactly replicate the behavior of @code`clojure.data/diff` using Janet tables, structs, arrays, and tuples in place of their Clojure equivalents.
@@ -10,7 +10,7 @@
The @code`diff` function recursively compares the structure and contents of two data structures (struct, table, tuple, array) and returns an array with three elements:
-@code`@[things-only-in-a things-only-in-b things-in-both]`
+@codeblock`@[things-only-in-a things-only-in-b things-in-both]`
In the case of nested associative data structures (i.e., tables and structs), the comparison is recursive and the data structures are neatly partitioned into the same @code`@[things-only-in-a things-only-in-b things-in-both]` structure, but arbitrary levels deep in the two original associative data structures.
diff --git a/doc/formatting.mdz b/doc/formatting.mdz
index ba3779d..f5842a4 100644
--- a/doc/formatting.mdz
+++ b/doc/formatting.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 1}
+ :order 2}
---
Provides a way to format Janet code strings and files.
diff --git a/doc/generators.mdz b/doc/generators.mdz
index 995f561..0817e26 100644
--- a/doc/generators.mdz
+++ b/doc/generators.mdz
@@ -2,7 +2,7 @@
:author "Z. D. Smith"
:license "BSD3"
:template "mdzdoc/main.html"
- :order 11}
+ :order 3}
---
# Generators for Janet
diff --git a/doc/htmlgen.mdz b/doc/htmlgen.mdz
index 5a7471c..1c989ad 100644
--- a/doc/htmlgen.mdz
+++ b/doc/htmlgen.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 12}
+ :order 4}
---
HTMLgen is a rendering engine that can render plain data structures into
diff --git a/doc/http.mdz b/doc/http.mdz
index d206726..b677e4e 100644
--- a/doc/http.mdz
+++ b/doc/http.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 0}
+ :order 5}
---
The @code`http` module is an HTTP/1.1 parser, server and client module. It proves a simple server implementation, client, support for chunked encoding.
diff --git a/doc/index.mdz b/doc/index.mdz
index 1461999..0759cc8 100644
--- a/doc/index.mdz
+++ b/doc/index.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 0}
+ :order 6}
---
Spork is a utility library for Janet. It contains a number of small
diff --git a/doc/message-protocol.mdz b/doc/message-protocol.mdz
index 315adf4..058f804 100644
--- a/doc/message-protocol.mdz
+++ b/doc/message-protocol.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 2}
+ :order 7}
---
Provide a symmetric way to send and receive seqential messages over a
diff --git a/doc/misc.mdz b/doc/misc.mdz
index a497e9c..f224796 100644
--- a/doc/misc.mdz
+++ b/doc/misc.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 9}
+ :order 8}
---
## Dedent
diff --git a/doc/networked-repl.mdz b/doc/networked-repl.mdz
index c0be04c..541c399 100644
--- a/doc/networked-repl.mdz
+++ b/doc/networked-repl.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 3}
+ :order 9}
---
Launch a networked REPL server on one machine and connect to it from
diff --git a/doc/path.mdz b/doc/path.mdz
index 2e272ee..0fc6206 100644
--- a/doc/path.mdz
+++ b/doc/path.mdz
@@ -2,9 +2,8 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 5}
+ :order 10}
---
-
Simple path manipulation module for Janet. Supports manipulation both
windows and posix paths on any platform, and provides functions that
work according to the current host platform.
@@ -14,6 +13,7 @@ All functions have three forms, under @code`path`, @code`path/win`, and
manipulates.
@codeblock[janet]```
+
(import spork/path)
# Examples for a non-windows system, use path/win/ for windows and
@@ -29,5 +29,7 @@ path/delim # -> ":" on posix, ";" on windows
(path/join "some/path" "../thing/file.txt") # -> "some/thing/file.txt"
(path/abspath? "/home/blah") # -> true
(path/abspath "file.txt") # -> "/home/me/cwd/file.txt"
-(path/relpath "a/nested/directory/with/a/few/children" "a/nested/directory/with/different/children") # -> "../../../different/children"
+(path/relpath
+ "a/nested/directory/with/a/few/children"
+ "a/nested/directory/with/different/children") # -> "../../../different/children"
```
diff --git a/doc/randgen.mdz b/doc/randgen.mdz
index 046118f..e1a1f22 100644
--- a/doc/randgen.mdz
+++ b/doc/randgen.mdz
@@ -1,13 +1,13 @@
-{:title "Randgen"
+{:title "Random Generator"
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 5}
+ :order 11}
---
A small utility for random number generation, especially with a focus on
discrete numbers. The most powerful idea here is the ability to have branches
-that execute probabalistically - i.e. one branch is taken half the time
+that execute in a probabilistic manner - i.e. one branch is taken half the time
randomly, and another is taken otherwise.
@codeblock[janet]```
@@ -16,5 +16,5 @@ randomly, and another is taken otherwise.
(randgen/rand-path
(print "a")
(print "b")
- (print "c))
+ (print "c"))
```
diff --git a/doc/regex.mdz b/doc/regex.mdz
index a38a38c..644c945 100644
--- a/doc/regex.mdz
+++ b/doc/regex.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 10}
+ :order 12}
---
A module for compiling a subset of regexes to Janet PEGs.
@@ -23,4 +23,4 @@ Supported regex features:
- Non-capture groups, e.g. @code`(?:abc)`
Features found in other regex may never be added - for more complex usage,
-use Janet's native PEG library. \ No newline at end of file
+use Janet's native PEG library.
diff --git a/doc/rpc-protocol.mdz b/doc/rpc-protocol.mdz
index 815e922..e6cbe5a 100644
--- a/doc/rpc-protocol.mdz
+++ b/doc/rpc-protocol.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 4}
+ :order 13}
---
A simple remote procedure call tool for Janet.
diff --git a/doc/temple.mdz b/doc/temple.mdz
index 19dd624..9fafcfa 100644
--- a/doc/temple.mdz
+++ b/doc/temple.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 7}
+ :order 14}
---
HTML templates for Janet.
diff --git a/doc/test.mdz b/doc/test.mdz
index bc973eb..5b5e4b2 100644
--- a/doc/test.mdz
+++ b/doc/test.mdz
@@ -2,7 +2,7 @@
:author "Calvin Rose"
:license "MIT"
:template "mdzdoc/main.html"
- :order 8}
+ :order 15}
---
This module contains a simple test helper when you do not need a specialized