diff options
author | p1xelHer0 <p_nagy@icloud.com> | 2023-12-19 09:08:56 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-12-19 10:08:56 +0200 |
commit | 9d0c3892d45b0b643cc12d9437f61d3154b3ba88 (patch) | |
tree | 24cbc321800a24085ec94d0a8ff3ca5773806eae | |
parent | f573cdd0ed7e17588961b189b0c0ef63b54390af (diff) |
Docs: 404 links, `generic.md` headlines, misc (#1091)add-arch-linux-docker
- Reference - Prelude - Core Expander Syntax: the opening paragraph now
links to the reference of the `current-expander-context` instead of
404ing.
- fixed comment spacing in the `core-expand` example.
- Reference - Standard Library - Generics: all the predefined types
starting with `<` failed to render on the site, this has been corrected
and they should now render correctly, including the sidebar content of
said types.
- Reference - Standard Library - Iterators: now correctly links to the
Guide explaining iterators.
- refer to "the guide" on in on the website itself as "Guide" with
uppercase G. This seemed to be a pattern in other parts of the docs.
- Reference - Standard Library - Syntax Parameters: link to the
`std/actor-v18/message.ss` instead of `actor`. `actor` does not exist,
only `actor-v18` and `actor-v13`. Is `v18` the correct one to link to?
-rw-r--r-- | doc/reference/gerbil/prelude/core-expander-syntax.md | 6 | ||||
-rw-r--r-- | doc/reference/std/generic.md | 114 | ||||
-rw-r--r-- | doc/reference/std/iterators.md | 4 | ||||
-rw-r--r-- | doc/reference/std/make.md | 2 | ||||
-rw-r--r-- | doc/reference/std/stxparam.md | 2 |
5 files changed, 64 insertions, 64 deletions
diff --git a/doc/reference/gerbil/prelude/core-expander-syntax.md b/doc/reference/gerbil/prelude/core-expander-syntax.md index 3c737a16..59a2bb4d 100644 --- a/doc/reference/gerbil/prelude/core-expander-syntax.md +++ b/doc/reference/gerbil/prelude/core-expander-syntax.md @@ -4,7 +4,7 @@ Gerbil is a Meta-Scheme that bases the expansion of forms on the context present while expanding. When expanded by the compiler or interpreter a form could have very different meanings depending on the -[current-expander-context](/reference/core-expander.html#current-expander-context). +[current-expander-context](/reference/gerbil/expander/#current-expander-context). These syntactic forms come from the root context, which is the parent context @@ -105,7 +105,7 @@ Include the contents of path, wrapped with a `begin`. [(else body ...)]) <feature>: - (and feature ...) ; boolean and of `feature ...` + (and feature ...) ; boolean and of `feature ...` (or feature ...) ; boolean or of `feature ...` (not feature) ; negation of feature id ; satisfied if `id` is bound as an identifier @@ -159,7 +159,7 @@ Plain old Scheme `lambda`, without optional and keyword argument support (case-lambda (lambda-formals body ...) ...) ``` -### let-values letrec-values letrec*-values +### let-values letrec-values letrec\*-values ``` scheme (let-values (((id ...) expr) ...) body ...) (letrec-values (((id ...) expr) ...) body ...) diff --git a/doc/reference/std/generic.md b/doc/reference/std/generic.md index b7951102..183e8160 100644 --- a/doc/reference/std/generic.md +++ b/doc/reference/std/generic.md @@ -43,371 +43,371 @@ Please document me! ## Predefined Types -### <bignum> +### \<bignum> ``` (defprimitive-type <bignum> ...) ``` Please document me! -### <boolean> +### \<boolean> ``` (defprimitive-type <boolean> ...) ``` Please document me! -### <box> +### \<box> ``` (defprimitive-type <box> ...) ``` Please document me! -### <byte-port> +### \<byte-port> ``` (defbuiltin-type <byte-port> ...) ``` Please document me! -### <char> +### \<char> ``` (defprimitive-type <char> ...) ``` Please document me! -### <character-port> +### \<character-port> ``` (defbuiltin-type <character-port> ...) ``` Please document me! -### <complex> +### \<complex> ``` (defprimitive-type <complex> ...) ``` Please document me! -### <condvar> +### \<condvar> ``` (defbuiltin-type <condvar> ...) ``` Please document me! -### <continuation> +### \<continuation> ``` (defprimitive-type <continuation> ...) ``` Please document me! -### <device-port> +### \<device-port> ``` (defbuiltin-type <device-port> ...) ``` Please document me! -### <directory-port> +### \<directory-port> ``` (defbuiltin-type <directory-port> ...) ``` Please document me! -### <eof> +### \<eof> ``` (defprimitive-type <eof> ...) ``` Please document me! -### <event-queue-port> +### \<event-queue-port> ``` (defbuiltin-type <event-queue-port> ...) ``` Please document me! -### <exception> +### \<exception> ``` (defbuiltin-type <exception> ...) ``` Please document me! -### <f32vector> +### \<f32vector> ``` (defprimitive-type <f32vector> ...) ``` Please document me! -### <f64vector> +### \<f64vector> ``` (defprimitive-type <f64vector> ...) ``` Please document me! -### <fixnum> +### \<fixnum> ``` (defprimitive-type <fixnum> ...) ``` Please document me! -### <flonum> +### \<flonum> ``` (defprimitive-type <flonum> ...) ``` Please document me! -### <foreign> +### \<foreign> ``` (defprimitive-type <foreign> ...) ``` Please document me! -### <hash-table> +### \<hash-table> ``` (defprimitive-type <hash-table> ...) ``` Please document me! -### <integer> +### \<integer> ``` (defprimitive-type <integer> ...) ``` Please document me! -### <keyword> +### \<keyword> ``` (defprimitive-type <keyword> ...) ``` Please document me! -### <mutex> +### \<mutex> ``` (defbuiltin-type <mutex> ...) ``` Please document me! -### <null> +### \<null> ``` (defprimitive-type <null> ...) ``` Please document me! -### <number> +### \<number> ``` (defprimitive-type <number> ...) ``` Please document me! -### <object-port> +### \<object-port> ``` (defbuiltin-type <object-port> ...) ``` Please document me! -### <object> +### \<object> ``` (defprimitive-type <object> ...) ``` Please document me! -### <pair> +### \<pair> ``` (defprimitive-type <pair> ...) ``` Please document me! -### <port> +### \<port> ``` (defbuiltin-type <port> ...) ``` Please document me! -### <procedure> +### \<procedure> ``` (defprimitive-type <procedure> ...) ``` Please document me! -### <promise> +### \<promise> ``` (defprimitive-type <promise> ...) ``` Please document me! -### <rational> +### \<rational> ``` (defprimitive-type <rational> ...) ``` Please document me! -### <raw-device-port> +### \<raw-device-port> ``` (defbuiltin-type <raw-device-port> ...) ``` Please document me! -### <readtable> +### \<readtable> ``` (defbuiltin-type <readtable> ...) ``` Please document me! -### <real> +### \<real> ``` (defprimitive-type <real> ...) ``` Please document me! -### <s16vector> +### \<s16vector> ``` (defprimitive-type <s16vector> ...) ``` Please document me! -### <s32vector> +### \<s32vector> ``` (defprimitive-type <s32vector> ...) ``` Please document me! -### <s64vector> +### \<s64vector> ``` (defprimitive-type <s64vector> ...) ``` Please document me! -### <s8vector> +### \<s8vector> ``` (defprimitive-type <s8vector> ...) ``` Please document me! -### <string-port> +### \<string-port> ``` (defbuiltin-type <string-port> ...) ``` Please document me! -### <string> +### \<string> ``` (defprimitive-type <string> ...) ``` Please document me! -### <symbol> +### \<symbol> ``` (defprimitive-type <symbol> ...) ``` Please document me! -### <t> +### \<t> ``` (defprimitive-type <t> ...) ``` Please document me! -### <tcp-server-port> +### \<tcp-server-port> ``` (defbuiltin-type <tcp-server-port> ...) ``` Please document me! -### <thread-group> +### \<thread-group> ``` (defbuiltin-type <thread-group> ...) ``` Please document me! -### <thread> +### \<thread> ``` (defbuiltin-type <thread> ...) ``` Please document me! -### <time> +### \<time> ``` (defbuiltin-type <time> ...) ``` Please document me! -### <type> +### \<type> ``` (defbuiltin-type <type> ...) ``` Please document me! -### <u16vector> +### \<u16vector> ``` (defprimitive-type <u16vector> ...) ``` Please document me! -### <u32vector> +### \<u32vector> ``` (defprimitive-type <u32vector> ...) ``` Please document me! -### <u64vector> +### \<u64vector> ``` (defprimitive-type <u64vector> ...) ``` Please document me! -### <u8vector-port> +### \<u8vector-port> ``` (defbuiltin-type <u8vector-port> ...) ``` Please document me! -### <u8vector> +### \<u8vector> ``` (defprimitive-type <u8vector> ...) @@ -415,28 +415,28 @@ Please document me! Please document me! -### <values> +### \<values> ``` (defprimitive-type <values> ...) ``` Please document me! -### <vector-port> +### \<vector-port> ``` (defbuiltin-type <vector-port> ...) ``` Please document me! -### <vector> +### \<vector> ``` (defprimitive-type <vector> ...) ``` Please document me! -### <void> +### \<void> ``` (defbuiltin-type <void> ...) ``` diff --git a/doc/reference/std/iterators.md b/doc/reference/std/iterators.md index 3cc7c2ca..24a9a4f7 100644 --- a/doc/reference/std/iterators.md +++ b/doc/reference/std/iterators.md @@ -1,6 +1,6 @@ # Iterators -The `:std/iter` library provides iterator support; see the [Guide](../guide/intro.md#iteration) +The `:std/iter` library provides iterator support; see the [Guide](/guide/intro.md#iteration) for an introduction. ::: tip To use bindings from this module: @@ -30,7 +30,7 @@ produced to the binding pattern, and evaluates the body for each value. For each iterable object an iterator is constructed using `(iter ...)`; the iteration completes as soon as one of the iterators completes. -### for* +### for\* ```scheme (for* (<bind> ...) body ...) (for* (<bind> when <filter-expr> ...) body ...) diff --git a/doc/reference/std/make.md b/doc/reference/std/make.md index 8adf42d6..72b6e86a 100644 --- a/doc/reference/std/make.md +++ b/doc/reference/std/make.md @@ -1,7 +1,7 @@ # Build Tool The `:std/make` library provides support for building source Gerbil projects. -See also the [guide](/reference/dev/build.md). +See also the [Guide](/reference/dev/build.md). ::: tip usage (import :std/make) diff --git a/doc/reference/std/stxparam.md b/doc/reference/std/stxparam.md index e3c2ed7d..14c0bf40 100644 --- a/doc/reference/std/stxparam.md +++ b/doc/reference/std/stxparam.md @@ -40,7 +40,7 @@ The `@@message` syntax parameter can also be cleanly re-parameterized without affecting existing macros. See [Keeping it Clean with Syntax Parameters](http://eli.barzilay.org/misc/stxparam.pdf) -and [std/actor/message.ss](https://github.com/mighty-gerbils/gerbil/blob/master/src/std/actor/message.ss). +and [std/actor-v18/message.ss](https://github.com/mighty-gerbils/gerbil/blob/master/src/std/actor-v18/message.ss). ::: |