Skip to content

Undeprecate annotate? #1322

Open
Open
@anntzer

Description

@anntzer

Is your feature request related to a problem? Please describe.
coverage annotate has been deprecated, which a suggestion to get in touch if it is still in use.
I don't absolutely need annotate, but it is nice to have for a self-contained solution on CI (not relying on external services such as codecov) for relatively small projects with already high coverage; e.g. one can easily use it to print out just the non-covered lines and their context with something like grep -C2 '^!' **/*,cover.

Describe the solution you'd like
Undeprecate annotate.

Describe alternatives you've considered
External services such as codecov are always available, of course.

Additional context
N/A

Activity

nedbat

nedbat commented on Nov 13, 2022

@nedbat
Owner

A number of people have written in to say they still use annotate. Perhaps I will change the message to something like, "this feature won't get much attention, look into alternatives" or something...

vallsv

vallsv commented on Dec 20, 2022

@vallsv

Hi.

I use to use this report. That's really useful to improve and tune some tests.

The documentation also talk about taking a look at "alternatives".

But there is none. The html report for example is just about statistics.
annotate is a line by line report.

My question is, is there alternatives, in case?

nedbat

nedbat commented on Dec 20, 2022

@nedbat
Owner

But there is none. The html report for example is just about statistics. annotate is a line by line report.

Each line in the HTML report is clickable, showing the lines in the file, with more details than are available in the annotate report.

vallsv

vallsv commented on Dec 20, 2022

@vallsv

Ah, nice. Thanks for the information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @nedbat@anntzer@vallsv

        Issue actions

          Undeprecate annotate? · Issue #1322 · nedbat/coveragepy