Skip to content

Commit

Permalink
docs: add additionnal info about typecheck (#4985)
Browse files Browse the repository at this point in the history
  • Loading branch information
ldez authored Sep 6, 2024
1 parent bf4a66a commit 24e6645
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/src/docs/welcome/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,19 @@ How to troubleshoot:
- [ ] Ensure you are not running an analysis on code that depends on files/packages outside the scope of the analyzed elements.
- [ ] If using CGO, ensure all require system libraries are installed.

## Why running with `--fast` is slow on the first run
## Why is it not possible to skip/ignore `typecheck` errors?

For mainly the same reasons that you cannot compile when you have a compiler error.

`typecheck` errors are reported in the same style as linter reports/issues,
but are completely different because they are related to problems that block the analysis (`typecheck` is not a linter).

When there are `typecheck` errors,
most linters are not able to perform the analysis,
and they simply do not produce any reports,
so it's not possible to skip/ignore `typecheck` errors.

## Why running with `--fast` is slow on the first run?

Because the first run caches type information. All subsequent runs will be fast.
Usually this options is used during development on local machine and compilation was already performed.
Expand Down

0 comments on commit 24e6645

Please sign in to comment.