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

Document justification as part of extended descriptions for applicable rules #5985

Open
eviathan opened this issue Mar 24, 2022 · 4 comments
Labels
status: ask to implement ask before implementing as may no longer be relevant type: documentation an improvement to the documentation

Comments

@eviathan
Copy link

Describe the documentation issue

There are a lot of rules and not much explanation as to why they are explicitly/ technically problematic and why they are included.

What solution would you like to see?

Either remove the rules or justify why they exist.

@jeddy3 jeddy3 changed the title All rules need justification as part of the documentation Document justification as part of extended descriptions for applicable rules Mar 24, 2022
@jeddy3 jeddy3 added status: ready to implement is ready to be worked on by someone type: documentation an improvement to the documentation labels Mar 24, 2022
@jeddy3
Copy link
Member

jeddy3 commented Mar 24, 2022

@eviathan Thanks for the report and for using the template.

We recently got better at doing this, e.g. the extended description for the color-function-notation rule or the upcoming selector-not-notation one. However, there are a number of historical rules that would benefit from extended descriptions.

I've labelled the issue as ready to implement. Please consider contributing if you have time.

It'd be fantastic if you could list the rules that you feel are in most need of justification so that we know where to start.

@eviathan
Copy link
Author

@jeddy3 If I can find the time I certainly can help you find the rules I am not sure I can help with the rationales for a lot of them though.

@jeddy3
Copy link
Member

jeddy3 commented Mar 24, 2022

If I can find the time I certainly can help you find the rules

That'd be great!

I am not sure I can help with the rationales for a lot of them though.

I can help here as I had a hand in the original discussions for most of the rules, and there's a good chance I'll remember the rationale for them.

Copy link
Contributor

This issue is older than one month. Please ask before opening a pull request, as it may no longer be relevant.

@github-actions github-actions bot added status: ask to implement ask before implementing as may no longer be relevant and removed status: ready to implement is ready to be worked on by someone labels Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: ask to implement ask before implementing as may no longer be relevant type: documentation an improvement to the documentation
Development

No branches or pull requests

2 participants