Skip to content

Commit

Permalink
Merge pull request #535 from ProducerMatt/patch-1
Browse files Browse the repository at this point in the history
Bring docs up-to-date
  • Loading branch information
jeremyjh authored Jun 19, 2024
2 parents 4d99c01 + d8d90eb commit cece72c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ mix dialyzer
* `--no-compile` - do not compile even if needed.
* `--no-check` - do not perform (quick) check to see if PLT needs to be updated.
* `--ignore-exit-status` - display warnings but do not halt the VM or return an exit status code.
* `--list-unused-filters` - list unused ignore filters useful for CI. do
not use with `mix do`.
* `--plt` - only build the required PLT(s) and exit
* `--format short` - format the warnings in a compact format, suitable for ignore file using Elixir term format.
* `--format raw` - format the warnings in format returned before Dialyzer formatting.
* `--format dialyxir` - format the warnings in a pretty printed format. (default)
Expand All @@ -47,6 +50,7 @@ mix dialyzer
* `--format ignore_file` - format the warnings in {file, warning} format for Elixir Format ignore file.
* `--format ignore_file_strict` - format the warnings in {file, short_description} format for Elixir Format ignore file.
* `--quiet` - suppress all informational messages.
* `--quiet-with-result` - suppress all informational messages except for the final result message

Warning flags passed to this task are passed on to `:dialyzer` - e.g.

Expand Down
3 changes: 2 additions & 1 deletion lib/mix/tasks/dialyzer.ex
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ defmodule Mix.Tasks.Dialyzer do
* `--format dialyxir` - format the warnings in a pretty printed format
* `--format dialyzer` - format the warnings in the original Dialyzer format
* `--format github` - format the warnings in the Github Actions message format
* `--format ignore_file` - format the warnings to be suitable for adding to Elixir Format ignore file
* `--format ignore_file` - format the warnings in {file, warning} format for Elixir Format ignore file
* `--format ignore_file_strict` - format the warnings in {file, short_description} format for Elixir Format ignore file.
* `--quiet` - suppress all informational messages
* `--quiet-with-result` - suppress all informational messages except for the final result message
Expand Down

0 comments on commit cece72c

Please sign in to comment.