Skip to content
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

Merged
merged 4 commits into from
Aug 12, 2024

Conversation

Whomy09
Copy link
Contributor

@Whomy09 Whomy09 commented Aug 10, 2024

No description provided.

@David-Pena David-Pena linked an issue Aug 10, 2024 that may be closed by this pull request
2 tasks
@David-Pena
Copy link
Collaborator

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.
File: Shows the path to the file where the rule is applied.
Description: A concise explanation of the rule, often accompanied by a link to relevant documentation for further details.
Message: Indicates the line of code where the rule was violated. Yellow messages are warnings, suggesting best practices, while red messages highlight errors that must be corrected.
⬆️

@David-Pena
Copy link
Collaborator

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

@David-Pena David-Pena added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 10, 2024
Copy link
Collaborator

@David-Pena David-Pena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check comments

@rrd108
Copy link
Owner

rrd108 commented Aug 10, 2024

Yes I think README should contain all the basics, including this.

@rrd108 rrd108 marked this pull request as draft August 10, 2024 08:11
@David-Pena David-Pena marked this pull request as ready for review August 12, 2024 03:45
@David-Pena David-Pena merged commit aa63b5f into rrd108:main Aug 12, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc add explanation of the output
3 participants