mirrors/janet
1
0
Fork 0
mirror of https://github.com/janet-lang/janet synced 2025-10-09 04:52:28 +00:00
Code Issues 1 Releases Wiki Activity

Merge pull request #1647 from sogaiu/tweak-flycheck-related-docstrings

Browse Source
This commit is contained in:
Calvin Rose
2025-09-21 00:53:51 -05:00
committed by GitHub
parent 06873fbf0b dd59d84b51
commit ed2ae562c6
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/boot/boot.janet
View File

@@ -4023,8 +4023,10 @@
(defn- flycheck-evaluator (defn- flycheck-evaluator
`` ``
An evaluator function that is passed to `run-context` that lints (flychecks) code for `flycheck`. An evaluator function that is passed to `run-context` that lints
This means code will parsed and compiled, macros expanded, but the code will not be evaluated. (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] [thunk source env where]
(when (and (tuple? source) (= (tuple/type source) :parens)) (when (and (tuple? source) (= (tuple/type source) :parens))
@@ -4041,10 +4043,12 @@
(defn flycheck (defn flycheck
``` ```
Check a file for errors without running the file. Found errors will be printed to stderr Check a file for errors without running the file. Found errors
in the usual format. Top level functions and macros that have the metadata `:flycheck` will will be printed to stderr in the usual format. Top level functions
also be evaluated during flychecking. For full control, The `flycheck` metadata can also be a function and macros that have the metadata `:flycheck` will also be evaluated
the takes 4 arguments - `thunk`, `source`, `env`, and `where`, the same as the `:evaluator` argument to `run-context`. 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. Other arguments to `flycheck` are the same as `dofile`. Returns nil.
``` ```
[path &keys kwargs] [path &keys kwargs]