GithubHelp home page GithubHelp logo

Comments (2)

platisd avatar platisd commented on June 2, 2024

Interesting, I haven't used them before. I guess you mean that the different issues shouldn't be posted as comments but instead for a "fix this" option to be displayed at the end of the run?

Two questions. If a user clicks in the "fix" button:

  1. What should happen if there's an error but no suggestion on how to fix? Just leave a comment?
  2. What happens in the case of false positive warnings that the user may want to suppress? Will clicking "fix" blanket-apply everything? Then a user may have to manually revert the unwanted ones.

from clang-tidy-pr-comments.

pqn avatar pqn commented on June 2, 2024

Interesting, I haven't used them before. I guess you mean that the different issues shouldn't be posted as comments but instead for a "fix this" option to be displayed at the end of the run?

The issues show up as an annotation as opposed to a comment (but both are rendered inline in the code). So I think the main benefit is for a code review with a lot of (automated) annotations and (manual) reviewer comments, you can hide one category and keep the other visible. And then as you mentioned, there is a single fix button instead of manually having to accept many suggestions.

image

I did some Googling and found a couple repos which are examples of triggering annotations from GH Actions, although I haven't tested them:

1. What should happen if there's an error but no suggestion on how to fix? Just leave a comment?

Yes, you should be able to have an annotation.

2. What happens in the case of false positive warnings that the user may want to suppress? Will clicking "fix" blanket-apply everything? Then a user may have to manually revert the unwanted ones.

This is a good point. I assume users have tuned their configuration to have minimal false positives. Then I think the workflow would be to ask them to add // NOLINT, etc. to the places with false positives, push the changes and re-trigger clang-tidy, and then be left with only fixes they want.

from clang-tidy-pr-comments.

Related Issues (17)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.