diff options
| author | Andrey Listopadov <andreyorst@gmail.com> | 2021-02-17 19:29:10 +0300 |
|---|---|---|
| committer | Andrey Listopadov <andreyorst@gmail.com> | 2021-02-17 19:29:10 +0300 |
| commit | a7047d22c756222728ec1e2cd863c4875610be6e (patch) | |
| tree | e78cb318ab1e96ea5bed92f64e66d2fb6581cdac /doc | |
| parent | 5bc5ed932c1f564188938e7e07283f9720c6088a (diff) | |
fix(doc): use automatic link resolution in docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cljlib.md | 16 | ||||
| -rw-r--r-- | doc/macros.md | 4 | ||||
| -rw-r--r-- | doc/tests/test.md | 2 |
3 files changed, 11 insertions, 11 deletions
diff --git a/doc/cljlib.md b/doc/cljlib.md index a06fca5..06bb18e 100644 --- a/doc/cljlib.md +++ b/doc/cljlib.md @@ -17,7 +17,7 @@ This example is mapping an anonymous `function` over a table, producing new table and concatenating it with `" "`. However this library also provides Fennel-specific set of -[macros](./cljlib-macros.md), that provides additional facilities like +[macros](./macros.md), that provides additional facilities like `fn*` or `defmulti` which extend the language allowing writing code that looks and works mostly like Clojure. @@ -258,7 +258,7 @@ Non empty associative tables are tested for two things: - `next` returns the key-value pair, - key, that is returned by the `next` is not equal to `1`. -Empty tables can't be analyzed with this method, and `map?` will +Empty tables can't be analyzed with this method, and [`map?`](#map) will return `false`. If you need this test pass for empty table, see [`hash-map`](#hash-map) for creating tables that have additional metadata attached for this test to work. @@ -300,9 +300,9 @@ Non empty sequential tables are tested for two things: - `next` returns the key-value pair, - key, that is returned by the `next` is equal to `1`. -Empty tables can't be analyzed with this method, and `vector?` will +Empty tables can't be analyzed with this method, and [`vector?`](#vector) will always return `false`. If you need this test pass for empty table, -see [`vector`](#vector) for creating tables that have additional +see [`vector`](#vector-1) for creating tables that have additional metadata attached for this test to work. ### Examples @@ -322,7 +322,7 @@ Empty tables: (assert-not (vector? some-table)) ``` -Empty tables created with [`vector`](#vector) will pass the test: +Empty tables created with [`vector`](#vector-1) will pass the test: ``` fennel (local some-table (vector)) @@ -339,7 +339,7 @@ Function signature: Test if `mf` is an instance of `multifn`. `multifn` is a special kind of table, created with `defmulti` macros -from `cljlib-macros.fnl`. +from `macros.fnl`. ## `set?` Function signature: @@ -1151,7 +1151,7 @@ tell you if something is in the set or not. Hash set differs from ordered set in that the keys are do not have any particular order. New items are added at the arbitrary position by -using [`conj`](#con) or `tset` functions, and items can be removed +using [`conj`](#conj) or `tset` functions, and items can be removed with [`disj`](#disj) or `tset` functions. Rest semantics are the same as for [`ordered-set`](#ordered-set) @@ -1167,5 +1167,5 @@ Copyright (C) 2020-2021 Andrey Listopadov License: [MIT](https://gitlab.com/andreyorst/fennel-cljlib/-/raw/master/LICENSE) -<!-- Generated with Fenneldoc 0.1.0 +<!-- Generated with Fenneldoc 0.1.2 https://gitlab.com/andreyorst/fenneldoc --> diff --git a/doc/macros.md b/doc/macros.md index fdced4e..3b99c3e 100644 --- a/doc/macros.md +++ b/doc/macros.md @@ -231,7 +231,7 @@ Function signature: Wrapper around `local` which can declare variables inside namespace, and as local `name` at the same time similarly to -[`fn*`](#fn*). Accepts optional `attr-map?` which can contain a +[`fn*`](#fn). Accepts optional `attr-map?` which can contain a docstring, and whether variable should be mutable or not. Sets variable to the result of `expr`. @@ -594,5 +594,5 @@ Copyright (C) 2020-2021 Andrey Listopadov License: [MIT](https://gitlab.com/andreyorst/fennel-cljlib/-/raw/master/LICENSE) -<!-- Generated with Fenneldoc 0.1.0 +<!-- Generated with Fenneldoc 0.1.2 https://gitlab.com/andreyorst/fenneldoc --> diff --git a/doc/tests/test.md b/doc/tests/test.md index f9d8ae9..2f5f87a 100644 --- a/doc/tests/test.md +++ b/doc/tests/test.md @@ -93,5 +93,5 @@ Assert `expr` for not truth. Generates more verbose message if `msg` is not set. Works the same as [`assert-is`](#assert-is). -<!-- Generated with Fenneldoc 0.1.0 +<!-- Generated with Fenneldoc 0.1.2 https://gitlab.com/andreyorst/fenneldoc --> |