Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
michallepicki authored Dec 18, 2024
1 parent 9e7e374 commit 191937b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This repository runs a [Dialyzer](http://erlang.org/doc/man/dialyzer.html) check
in the Elixir source code itself. Elixir CI only checks that types and specs syntax generated by the compiler is valid (without actually performing Dialyzer analysis), and there is a small [Dialyzer test suite](https://github.com/elixir-lang/elixir/tree/main/lib/elixir/test/elixir/fixtures/dialyzer) to ensure core macros don't cause Dialyzer issues.

This project _may_ find some Dialyzer issues that propagate and show up in Elixir stdlib or tooling code _usage_ (e.g. warnings in your correct Elixir code caused by wrong specs in the Elixir stdlib), but only coincidentally and only for the usages present in Elixir source code itself (this project doesn't analyze tests where most of stdlib usage lives - Elixir tests are interpreted and don't produce `.beam` files that can be analyzed with Dialyzer easily).
Unfortunately this project won't find all issues that propagate and show up in Elixir stdlib or tooling code _usage_ (e.g. warnings in your correct Elixir code caused by wrong specs in the Elixir stdlib) because this project doesn't analyze tests where most of stdlib usage lives - Elixir tests are interpreted and don't produce `.beam` files that can be analyzed with Dialyzer easily.

Reports can be found at https://github.com/michallepicki/elixir-lang-dialyzer-runs/actions?query=workflow%3Adialyzer+branch%3Amaster . Click the last event, then `dialyzer` on the left, then expand "Check Elixir" step to see issues. The report is also uploaded as a build artifact. Potential issues are at the end of the output (if any). Filtered non-issues are printed but don't affect the success/failure status code.

Expand Down

0 comments on commit 191937b

Please sign in to comment.