-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: output explanation #124
feat: output explanation #124
Conversation
I like the content and structure of the explanation, I noticed a few wordings that might be a bit confusing, check it out this markdown with a few changes in the wordings, and let me know what do you think? @Whomy09 ⬇️ Group by Rule: In this view, the first line is highlighted in blue, representing the rule being evaluated. Following this, you'll see blocks of information structured as follows: file path, description, and message. Group by File: In this view, the first line displays the file path being evaluated. Below this, you'll see blocks of information with the following structure: rule, description, and message. Rule: The blue line that defines the specific rule being evaluated. |
Also, this issue was about adding the output explanation to the docs, not to the README Maybe we can leave it in both places? @rrd108 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please check comments
Yes I think README should contain all the basics, including this. |
No description provided.