diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2021-10-29 06:33:31 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2021-10-29 06:33:31 -0400 |
| commit | 59b07a12de95de776fa2f44a2101f63a156fee75 (patch) | |
| tree | 464bd511dd250e1917df5536fe14b4098e2749fc /doc | |
| parent | 81a55d102550b4535191756960f6846083fc7e30 (diff) | |
| download | python-coveragepy-git-59b07a12de95de776fa2f44a2101f63a156fee75.tar.gz | |
deprecated: the annotate command will be removed in a future version
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cmd.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index 2ce7cc13..b674e298 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -511,6 +511,11 @@ Other common reporting options are described above in :ref:`cmd_reporting`. Text annotation: ``coverage annotate`` -------------------------------------- +.. note:: + The **annotate** command has been obsoleted by more modern reporting tools, + including the **html** command. **annotate** will be removed in a future + version. + The **annotate** command produces a text annotation of your source code. With a ``-d`` argument specifying an output directory, each Python file becomes a text file in that directory. Without ``-d``, the files are written into the |