Skip to content

Commit dd59d84

Browse files
author
sogaiu
committed
Tweak some flycheck-related docstrings
1 parent 06873fb commit dd59d84

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

src/boot/boot.janet

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4023,8 +4023,10 @@
40234023

40244024
(defn- flycheck-evaluator
40254025
``
4026-
An evaluator function that is passed to `run-context` that lints (flychecks) code for `flycheck`.
4027-
This means code will parsed and compiled, macros expanded, but the code will not be evaluated.
4026+
An evaluator function that is passed to `run-context` that lints
4027+
(flychecks) code for `flycheck`. This means code will be parsed,
4028+
compiled, and have macros expanded, but the code will not be
4029+
evaluated.
40284030
``
40294031
[thunk source env where]
40304032
(when (and (tuple? source) (= (tuple/type source) :parens))
@@ -4041,10 +4043,12 @@
40414043

40424044
(defn flycheck
40434045
```
4044-
Check a file for errors without running the file. Found errors will be printed to stderr
4045-
in the usual format. Top level functions and macros that have the metadata `:flycheck` will
4046-
also be evaluated during flychecking. For full control, The `flycheck` metadata can also be a function
4047-
the takes 4 arguments - `thunk`, `source`, `env`, and `where`, the same as the `:evaluator` argument to `run-context`.
4046+
Check a file for errors without running the file. Found errors
4047+
will be printed to stderr in the usual format. Top level functions
4048+
and macros that have the metadata `:flycheck` will also be evaluated
4049+
during flychecking. For full control, the `:flycheck` metadata can
4050+
also be a function that takes 4 arguments - `thunk`, `source`, `env`,
4051+
and `where`, the same as the `:evaluator` argument to `run-context`.
40484052
Other arguments to `flycheck` are the same as `dofile`. Returns nil.
40494053
```
40504054
[path &keys kwargs]

0 commit comments

Comments
 (0)