Add documentation on CLI Output report #199
Open
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.
I tried out the CLI but found the documentation lacking. I added a short blurb in case anyone else needs to look for basic information as to what is included in the report.
This was in regards to the issue I raised here.
Here is a screenshot of the updated documentation.
![Screenshot 2024-06-05 at 2 16 52 PM](https://private-user-images.githubusercontent.com/40117342/336959019-c33bac97-ba81-422c-b1ad-ddc4a7df209c.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk1MTU4ODUsIm5iZiI6MTczOTUxNTU4NSwicGF0aCI6Ii80MDExNzM0Mi8zMzY5NTkwMTktYzMzYmFjOTctYmE4MS00MjJjLWIxYWQtZGRjNGE3ZGYyMDljLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMTQlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjE0VDA2NDYyNVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTYyZDQwMzQxNzA4NDA1NDc1NDk2MmE2NTM4Y2IwNGJhMGE1MTMxY2Q3NTIxYWM3YWJhMWIyMWM3ZDc0M2Y3NGImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.J03C_omt9VN7ZT4atXMPh4tLBuz0_m9Qqt51G_6dpFs)