Skip to content

docs(rules): usage argumentation #340

Open
@Kristinita

Description

@Kristinita

1. Summary

It would be nice, if HTMLHint documentation will contain arguments, why HTMLHint users must use specific rules.

2. Argumentation

“Must” in The script tag can not be used in head., Id and class value must meet some rules: underline, dash, hump. is not argument. The documentation does not show the reasons. Users should know “Why must”?

3. Example of expected behavior

As for CSSLint wiki. Examples:

HTMLHint wiki doesn't contain similar argumentation.

4. Specific rules

At first, I want to know argumentation for these rules.

4.1. head-script-disabled

Most popular Stack Overflow answer with 1608 stars at March 2019:

The current state-of-the-art is to put scripts in the <head> tag and use the async or defer attributes. This allows your scripts to be downloaded asap without blocking your browser.

Script tag must be used in head.

4.2. id-class-value

BEM — the most popular CSS methodology use underlines and dashes both. Example from BEM quick-start:

<!-- `search-form` block -->
<form class="search-form">
    <!-- `input` element in the `search-form` block -->
    <input class="search-form__input">

    <!-- `button` element in the `search-form` block -->
    <button class="search-form__button">Search</button>
</form>

Users don't need use underlines or dashes.

5. Do not offer

Yes, I know, that I can enable/disable/modify specific HTMLHint rules. My question not about it.

Thanks.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationkeep-unstaleThe issue will not be marked as stale by the stale-bot

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions