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

lit-a11y/list exists in recommended rules list but not in the overview.md docs #2796

Open
Shadebane opened this issue May 13, 2024 · 2 comments

Comments

@Shadebane
Copy link

Expected behavior

'Recommended rules' is at a minimum a subset of 'Supported rules', so that there is no confusion around which rules might be turned on by default when using the recommended rules

Actual Behavior

'lit-a11y/list' is missing from the list of supported rules, which is causing confusion on whether or not it is a rule that is meant to be in the recommended list of linting rules or if it has been deprecated or something.

Additional context

Plugin: eslint-plugin-lit-a11y v4.1.2

Just trying to get some clarity on whether or not this rule is meant to be in the supported rules list - it looks like it may just have been missed when this file was originally ported over 4 years ago. I see no reference to any discussion on it the original PR that would suggest otherwise, at any rate.

@thepassle
Copy link
Member

Looks like the docs just got out of sync with source code. Would you be willing to create a pr to update it?

@Shadebane
Copy link
Author

Shadebane commented May 13, 2024

Looks like the docs just got out of sync with source code. Would you be willing to create a pr to update it?

Done. I kept the scope to this issue but there seem to be other examples outside this rule( definition-list, heading-hidden, - basically any rule added since the overview list was established).

I don't mind syncing the overview list but i wonder if a better solution couldn't be found. I don't have any insight into the reason behind the division between the package folder & the docs folder (when the package folder also has its own docs), so it seems a bit presumptuous for me to try to 'fix' something I don't even understand.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants