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

Docs: README: wrong rule description, missing recommended list #273

Closed
1 task
danielrentz opened this issue Aug 26, 2024 · 3 comments · Fixed by #274
Closed
1 task

Docs: README: wrong rule description, missing recommended list #273

danielrentz opened this issue Aug 26, 2024 · 3 comments · Fixed by #274

Comments

@danielrentz
Copy link

Docs page(s)

https://github.com/eslint/markdown/blob/main/README.md

What documentation issue do you want to solve?

  1. Rule table: "no-html" contains wrong description "Enforce fenced code blocks to specify a language."
  2. There is no information which rules are included in "recommended".

What do you think is the correct solution?

  1. Rule table: "no-html" description should be "Disallow HTML tags.".
  2. The rule table should contain a "Recommended" column.

Participation

  • I am willing to submit a pull request for this change.

Additional comments

No response

@fasttime
Copy link
Member

Thanks! The wrong rule description looks like a copy-paste mistake, and I agree it would be good to indicate which rules are included in the recommended config. We could think of a way to update the docs automatically using rules metadata during the build like we do in ESLint. I believe this would make sense given that the recommended config is also autogenerated (in tools/build-rules.js). Would like @nzakas' perspective on this.

@nzakas
Copy link
Member

nzakas commented Aug 26, 2024

Yeah, just a copy-paste error. Updating the README automatically would be nice! Feel free to put that together.

@fasttime
Copy link
Member

I'll work on this.

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

Successfully merging a pull request may close this issue.

4 participants
@nzakas @danielrentz @fasttime and others