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.

Sign up for GitHub

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

Jump to bottom

Improve documentation of tags-check #1211

Open
groenroos opened this issue Oct 25, 2022 · 2 comments · May be fixed by #1383
Open

Improve documentation of tags-check #1211

groenroos opened this issue Oct 25, 2022 · 2 comments · May be fixed by #1383
Labels
documentation help wanted We are looking for community help keep-unstale The issue will not be marked as stale by the stale-bot

Comments

@groenroos
Copy link

groenroos commented Oct 25, 2022 •
edited

The current documentation of the tags-check rule is quite spartan, in that it doesn't explain in full the built-in constraints it checks for, or the way or format in which the end user project can extend or override these constraints.

I was able to understand the feature better (what exactly it does, how it can be customised, and what attributes are available) by reading the source code, but ideally these details would be included in the documentation as well.
@coliff coliff added documentation help wanted We are looking for community help labels Oct 25, 2022
@stale

This comment was marked as outdated.

Sign in to view
@stale stale bot added the bot:stale Issue marked as stale because there was no activity label Dec 26, 2022
@coliff coliff added the keep-unstale The issue will not be marked as stale by the stale-bot label Dec 26, 2022
@stale stale bot removed the bot:stale Issue marked as stale because there was no activity label Dec 26, 2022
@varun-khachane
Copy link

Hi, I would like to work on this issue. Can you please assign it to me ?

@hyperupcall hyperupcall linked a pull request Nov 27, 2023 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation help wanted We are looking for community help keep-unstale The issue will not be marked as stale by the stale-bot
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(tag-check): Add example and explain all options fox-forks/HTMLHint
3 participants
@groenroos @coliff @varun-khachane