From 7ba81a9b29053ab18445aa5a5541e329e6d03809 Mon Sep 17 00:00:00 2001 From: Todd Date: Thu, 12 Sep 2019 15:52:58 -0700 Subject: [PATCH] Update Use of Dialyzer in README (#713) :bookmark_tabs: :page_facing_up: There is no longer a task for `mix dialyzer.plt`. The PLT is now built by the process which runs with the `mix dialyzer` task. This change removes the note from the README file to run `mix dialyzer.plt`. :see_no_evil: The latest run of `mix dialyzer` created a new local file named `.dialyzer.plt.hash`. This change adds the file to `.gitignore`. --- .gitignore | 1 + README.md | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 803c62a4..acccbee8 100644 --- a/.gitignore +++ b/.gitignore @@ -20,6 +20,7 @@ npm-debug.log *.sublime-workspace *.sublime-project .dialyzer.plt +.dialyzer.plt.hash screenshots /config/*.secret.exs diff --git a/README.md b/README.md index d502c668..a8066dc7 100644 --- a/README.md +++ b/README.md @@ -76,9 +76,9 @@ Run `mix test` ## Static Analysis -Run `mix dialyzer.plt` to build the lookup table for static analysis. Then run -`mix dialyzer` to run analysis. If your dependencies or your elixir version -change, delete `.dialyzer.plt` and run `mix dialyzer.plt` to rebuild it. +Run `mix dialyzer` to run the analysis. The lookup table will be created by this +process. If your dependencies or your elixir version change, delete +`.dialyzer.plt` and run `mix dialyzer.plt` to rebuild it. There are still a lot of warnings that are not fixable, but occasionally some real errors are found by dialyzer