[report-converter] Improve documentation maintainability #4424
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
Reduce documentation duplication by: - Create a concise package-level README focused on quick start - Update setup.py to use a focused description - Point to official readthedocs.io documentation as single source of truth - Remove redundant information from package documentation
bruntib
requested changes
Jan 13, 2025
| report-converter --type clang-tidy --output /path/to/reports clang-tidy-output.txt | ||
|
|
||
| # Generate HTML report | ||
| plist-to-html --input /path/to/reports/*.plist --output /path/to/html |
There was a problem hiding this comment.
I can't find this plist-to-html script.
There was a problem hiding this comment.
There is an entry point defined for the report-converter package, which is named plist-to-html:
/tools/report-converter/setup.py
This is a way for Python packages to provide a CLI script once installed.
I just went ahead and included this one in the docs as well.
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.
Reduce documentation duplication by: