Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
fare committed Nov 8, 2023
1 parent ec6027d commit c150454
Show file tree
Hide file tree
Showing 14 changed files with 36 additions and 38 deletions.
2 changes: 1 addition & 1 deletion doc/reference/gerbil/expander/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -681,7 +681,7 @@ Please document me!

Please document me!

### core-module-export->import
### core-module-export->import
```
(core-module-export->import ...)
```
Expand Down
4 changes: 2 additions & 2 deletions doc/reference/gerbil/runtime/MOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ Accesses *obj*'s field with absolute offset *off*; there is no type check.

Mutates *obj*'s field with absolute offset *off* to *val*; there is no type check.

## struct->list
## struct->list
``` scheme
(struct->list obj) -> list
Expand Down Expand Up @@ -482,7 +482,7 @@ Returns the value associated with slot *slot* in *obj*, without any checks.

Sets the value associated with slot *slot* in *obj* to *val*, without any checks.

## class->list
## class->list
``` scheme
(class->list obj)
Expand Down
16 changes: 8 additions & 8 deletions doc/reference/gerbil/runtime/hash-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ Merges *more* hash tables into *hash*. Entries in hash tables on the left take p
((a . 1) (z . 6) (b . 2) (c . 3))
```

## hash->list
## hash->list
``` scheme
(hash->list hash) -> list
Expand All @@ -249,7 +249,7 @@ Merges *more* hash tables into *hash*. Entries in hash tables on the left take p

Returns the bindings of *hash* as an alist.

## list->hash-table
## list->hash-table
``` scheme
(list->hash-table lst . options) -> hash table
Expand All @@ -258,7 +258,7 @@ Returns the bindings of *hash* as an alist.

Creates a hash table from an alist *lst*.

## list->hash-table-eq
## list->hash-table-eq
``` scheme
(list->hash-table-eq lst . options) -> hash table
Expand All @@ -267,7 +267,7 @@ Creates a hash table from an alist *lst*.

Same as `list->hash-table`, but using `eq?` as the test function for the table.

## list->hash-table-eqv
## list->hash-table-eqv
``` scheme
(list->hash-table-eqv lst . options) -> hash table
Expand All @@ -276,7 +276,7 @@ Same as `list->hash-table`, but using `eq?` as the test function for the table.

Same as `list->hash-table`, but using `eqv?` as the test function for the table.

## hash->plist
## hash->plist
``` scheme
(hash->plist hash) -> list
Expand All @@ -285,7 +285,7 @@ Same as `list->hash-table`, but using `eqv?` as the test function for the table.

Returns the bindings of *hash* as a plist.

## plist->hash-table
## plist->hash-table
``` scheme
(plist->hash-table lst) -> hash table
Expand All @@ -294,7 +294,7 @@ Returns the bindings of *hash* as a plist.

Creates a hash table from a plist *lst*.

## plist->hash-table-eq
## plist->hash-table-eq
``` scheme
(plist->hash-table-eq lst) -> hash table
Expand All @@ -303,7 +303,7 @@ Creates a hash table from a plist *lst*.

Same as `plist->hash-table`, but using `eq?` as the test function for the table.

## plist->hash-table-eqv
## plist->hash-table-eqv
``` scheme
(plist->hash-table-eqv lst) -> hash table
Expand Down
4 changes: 2 additions & 2 deletions doc/reference/gerbil/runtime/misc-procedures.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ it is considered a single value.
Returns the *n*th value in the object *obj*. If the object is not multiple `values`,
it returns the object itself.

### values->list
### values->list
``` scheme
(values->list obj) -> list
Expand All @@ -30,7 +30,7 @@ it returns the object itself.
Converts multiple `values` to a list. If the object *obj* is not multiple `values`,
it returns a list containing the object.

### subvector->list
### subvector->list
``` scheme
(subvector->list obj [start = 0]) -> list
Expand Down
6 changes: 3 additions & 3 deletions doc/reference/gerbil/runtime/strings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Strings

## bytes->string
## bytes->string
```
(bytes->string bstr [encoding = 'UTF-8]) -> string
Expand All @@ -12,7 +12,7 @@ Decodes a byte vector *bstr* to a string.
Note: if you are decoding UTF-8, then you should consider using `string->utf8`
from `:std/text/utf8` which is considerably faster.

## string->bytes
## string->bytes
``` scheme
(string->bytes str [encoding = 'UTF-8]) -> u8vector
Expand All @@ -25,7 +25,7 @@ Note: if you are encoding UTF-8, then you should consider using `utf8->string`
from `:std/text/utf8` which is considerably faster.


## substring->bytes
## substring->bytes
``` scheme
(substring->bytes str start end [encoding = 'UTF-8]) -> u8vector
Expand Down
4 changes: 2 additions & 2 deletions doc/reference/gerbil/runtime/symbols.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Returns true if the object *obj* is an interned symbol.

Returns true if the object *obj* is an interned keyword.

## symbol->keyword
## symbol->keyword
``` scheme
(symbol->keyword sym) -> keyword
Expand All @@ -41,7 +41,7 @@ Returns true if the object *obj* is an interned keyword.

Converts a symbol *sym* to a keyword.

## keyword->symbol
## keyword->symbol
``` scheme
(keyword->symbol kw) -> symbol
Expand Down
4 changes: 2 additions & 2 deletions doc/reference/std/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Unix Command Line Interface
# Command Line Interface

The following libraries are provided to support the Unix Command Line Interface (CLI):
The following libraries are provided to support the Command Line Interface (CLI):
- [:std/cli/getopt](getopt.md)
- [:std/cli/shell](shell.md)
- [:std/cli/print-exit](print-exit.md)
Expand Down
4 changes: 2 additions & 2 deletions doc/reference/std/cli/getopt.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ For an example, here the a command line parser for the `gxpkg` program:
(search-pkgs .keywords)))))
```

### getopt-parse->function-arguments
### getopt-parse->function-arguments
```scheme
(getopt-parse->function-arguments getopt h) => list-of-arguments
```
Expand Down Expand Up @@ -250,7 +250,7 @@ e.g. with prototype objects like `gerbil-poo`.
TODO: add examples, discuss abort-on-error behavior,
lack of automatic help, etc.

### ->getopt-spec
### ->getopt-spec
```scheme
(->getopt-spec arg) => list-of-getopt-arguments
```
Expand Down
2 changes: 1 addition & 1 deletion doc/reference/std/cli/shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ when included in a Unix shell command, will expand into the input `string`.
```
:::

### ->envvar
### ->envvar
```scheme
(->envvar . str) => environment-variable-name
```
Expand Down
12 changes: 5 additions & 7 deletions doc/reference/std/getopt.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
# Command Line Argument Parsing

This is the old name of the `:std/cli/getopt` module,
This is the old name of the [`:std/cli/getopt`](cli/getopt.md) module,
that provides facilities for command line argument parsing.

As of Gerbil v0.19 this name is deprecated and
you should be using the new library instead,
but the old name remains available for now
for the sake of backward compatibility.
Up to Gerbil v0.18, `:std/getopt` was the only name for this module.
As of Gerbil v0.19, both names are supported.
However, we recommend you use the new name `:std/cli/getopt` from now on,
as we may deprecate the old name in the future.

::: tip usage
```scheme
(import :std/cli/getopt)
```
:::

<!-- See [:std/cli/getopt](cli/getopt.md) for the module documentation. -->
2 changes: 1 addition & 1 deletion doc/reference/std/misc/alist.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ A proper association list is a list of pairs and may be of the following forms:
```
:::

## plist-&gt;alist
## plist->alist
``` scheme
(plist->alist plist) -> alist | error
Expand Down
4 changes: 2 additions & 2 deletions doc/reference/std/misc/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
```
:::

## length=?, length&lt;? ... length&gt;=? ##
## length=?, length<? ... length>=? ##

```scheme
(length=? lst1 lst2) -> boolean
Expand Down Expand Up @@ -53,7 +53,7 @@ Also, either of these two lists is allowed to be circular, but not both.
```
:::

## length=n?, length&lt;n? ... length&gt;=n? ##
## length=n?, length<n? ... length>=n? ##

```scheme
(length=n? lst n) -> boolean | error
Expand Down
2 changes: 1 addition & 1 deletion doc/reference/std/misc/plist.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ form: `((key1 value1 key2 value2 ...))`
```
:::

## alist-&gt;plist
## alist->plist
``` scheme
(alist->plist alist) -> plist | error
Expand Down
8 changes: 4 additions & 4 deletions doc/reference/std/text/base64.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For some more references see:
```
:::

## base64-string-&gt;u8vector
## base64-string->u8vector
``` scheme
(base64-string->u8vector str [nopadding-ok?: #t] [urlsafe?: #f]) -> u8vector
Expand All @@ -50,7 +50,7 @@ control how the conversion is done. If *nopadding-ok?* is #t (default) the value
is converted. If *urlsafe?* is #t, the result is URL encoded as specified in RFC 4648.
...

## base64-substring-&gt;u8vector
## base64-substring->u8vector
``` scheme
(base64-substring->u8vector str start end [nopadding-ok?: #t] [urlsafe?: #f]) ->
u8vector
Expand All @@ -65,7 +65,7 @@ u8vector
Returns a newly allocated u8vector containing Base64 encoded value of *str* from
*start* to *end* like `base64-string->u8vector`.

## u8vector-&gt;base64-string
## u8vector->base64-string
``` scheme
(u8vector->base64-string u8vect [width: 0] [padding?: #t] [urlsafe?: #f]) -> string
Expand All @@ -77,7 +77,7 @@ Returns a newly allocated u8vector containing Base64 encoded value of *str* from

Returns a newly allocated Base64 string with bytes of *u8vect* in left-to-right order to Base64 encoded string.

## subu8vector-&gt;base64-string
## subu8vector->base64-string
``` scheme
(subu8vector->base64-string u8vect start end [width: 0] [padding?: #t] [urlsafe?: #f]) -> string
Expand Down

0 comments on commit c150454

Please sign in to comment.