summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2021-10-29 18:51:45 -0400
committerNed Batchelder <ned@nedbatchelder.com>2021-10-29 21:36:08 -0400
commit4c4f4ac9dcd7e9377c623ff11cac7cb3a65fc7ce (patch)
treecfec374c03e626b51d20db6b12542f57858c6198
parent59b07a12de95de776fa2f44a2101f63a156fee75 (diff)
downloadpython-coveragepy-git-4c4f4ac9dcd7e9377c623ff11cac7cb3a65fc7ce.tar.gz
docs: say a little more about annotate in the changelog
-rw-r--r--CHANGES.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/CHANGES.rst b/CHANGES.rst
index 342c5b24..54d91f3f 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -25,7 +25,10 @@ Unreleased
- Deprecated: The ``annotate`` command and the ``Coverage.annotate`` function
will be removed in a future version, unless people let me know that they are
- using it. Get in touch if you do: ned@nedbatchelder.com.
+ using it. Instead, the ``html`` command gives better-looking (and more
+ accurate) output, and the ``report -m`` command will tell you line numbers of
+ missing lines. Please get in touch if you have a reason to use ``annotate``
+ over those better options: ned@nedbatchelder.com.
- Feature: Coverage now sets an environment variable, ``COVERAGE_RUN`` when
running your code with the ``coverage run`` command. The value is not