aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorsogaiu <983021772@users.noreply.github.com>2025-09-21 13:30:31 +0900
committersogaiu <983021772@users.noreply.github.com>2025-09-21 14:09:35 +0900
commitdd59d84b516828c7fc078305a21fe69313151696 (patch)
tree7039df76c141b68a7589aece4b07ae8669d997b1
parentUpdate CHANGELOG.md (diff)
Tweak some flycheck-related docstrings
-rw-r--r--src/boot/boot.janet16
1 files changed, 10 insertions, 6 deletions
diff --git a/src/boot/boot.janet b/src/boot/boot.janet
index 731f2359..49c5a942 100644
--- a/src/boot/boot.janet
+++ b/src/boot/boot.janet
@@ -4023,8 +4023,10 @@
(defn- flycheck-evaluator
``
- An evaluator function that is passed to `run-context` that lints (flychecks) code for `flycheck`.
- This means code will parsed and compiled, macros expanded, but the code will not be evaluated.
+ An evaluator function that is passed to `run-context` that lints
+ (flychecks) code for `flycheck`. This means code will be parsed,
+ compiled, and have macros expanded, but the code will not be
+ evaluated.
``
[thunk source env where]
(when (and (tuple? source) (= (tuple/type source) :parens))
@@ -4041,10 +4043,12 @@
(defn flycheck
```
- Check a file for errors without running the file. Found errors will be printed to stderr
- in the usual format. Top level functions and macros that have the metadata `:flycheck` will
- also be evaluated during flychecking. For full control, The `flycheck` metadata can also be a function
- the takes 4 arguments - `thunk`, `source`, `env`, and `where`, the same as the `:evaluator` argument to `run-context`.
+ Check a file for errors without running the file. Found errors
+ will be printed to stderr in the usual format. Top level functions
+ and macros that have the metadata `:flycheck` will also be evaluated
+ during flychecking. For full control, the `:flycheck` metadata can
+ also be a function that takes 4 arguments - `thunk`, `source`, `env`,
+ and `where`, the same as the `:evaluator` argument to `run-context`.
Other arguments to `flycheck` are the same as `dofile`. Returns nil.
```
[path &keys kwargs]