document PR review feature caveats #70
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is mostly taken from a comment I posted in cpp-linter/cpp-linter-action#182 with some updates. Also reviewed other changes about the generated cli_args.rst document.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #70 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 19 19
Lines 1321 1319 -2
=========================================
- Hits 1321 1319 -2 ☔ View full report in Codecov by Sentry. |
|
This new information can be referred to from the cpp-linter-action repo's README file. The link to this new doc will be https://cpp-linter.github.io/cpp-linter/pr_review_caveats.html (URL broken until this is merged to main branch). |
|
The copyright in the link is still 2022, it might be better to keep up to date manually or automatically. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is mostly taken from a comment I posted in cpp-linter/cpp-linter-action#182 with some updates.
Also reviewed other changes about the generated cli_args.rst document.