diff options
author | Chris Dosé <chris.dose+github@pm.me> | 2022-01-04 22:34:54 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-01-05 08:34:54 +0200 |
commit | 2736b9465ab1f6c349789d4a3ae7f317a5d5306b (patch) | |
tree | 0cd776f1f2106a5c81b8d5d64af86681db11d63d | |
parent | 7356a47047d0b54517bd6886603f09b1121dde2b (diff) | |
download | elixir-2736b9465ab1f6c349789d4a3ae7f317a5d5306b.tar.gz |
Fix a few issues in the mix test.coverage docs (#11539)
-rw-r--r-- | lib/mix/lib/mix/tasks/test.coverage.ex | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/mix/lib/mix/tasks/test.coverage.ex b/lib/mix/lib/mix/tasks/test.coverage.ex index ff8c67306..6d9002cbc 100644 --- a/lib/mix/lib/mix/tasks/test.coverage.ex +++ b/lib/mix/lib/mix/tasks/test.coverage.ex @@ -6,7 +6,7 @@ defmodule Mix.Tasks.Test.Coverage do In this moduledoc, we will describe how the default test coverage works in Elixir and also explore how it is capable - of export coverage results to group reports from multiple + of exporting coverage results to group reports from multiple test runs. ## Line coverage @@ -15,8 +15,8 @@ defmodule Mix.Tasks.Test.Coverage do for its default test coverage. Erlang coverage is done by tracking *executable lines of code*. This implies blank lines, code comments, function signatures, and patterns are not necessarily executable and - therefore won't be tracked ín coverage reports. Code in macros are - also often executed at compilation time, and therefore may not covered. + therefore won't be tracked in coverage reports. Code in macros are + also often executed at compilation time, and therefore may not be covered. Similarly, Elixir AST literals, such as atoms, are not executable either. Let's see an example: @@ -64,7 +64,7 @@ defmodule Mix.Tasks.Test.Coverage do can help spot those cases, but they are not currently supported by the default coverage tool. - Overall, code coverage can be a great tool for finding out flaws in our + Overall, code coverage can be a great tool for finding flaws in our code (such as functions that haven't been covered) but it can also lead teams into a false sense of security since 100% coverage never means all different executions flows have been asserted, even with the most advanced |