Skip to content
This repository was archived by the owner on Nov 9, 2017. It is now read-only.
This repository was archived by the owner on Nov 9, 2017. It is now read-only.

Enable errors to be suppressed for some intentional cases (e.g., some cases of inline style attributes) #228

@sideshowbarker

Description

@sideshowbarker

Use of inline style attributes is an error I want to be alerted about, so it is extremely useful that the documentation tester catches it so I can fix pages that contain it.

However, some (very few) pages intentionally use the style attribute inline for particular reasons. For example, the https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s page uses the style attribute to illustrate how the native styling of the s element compares to styling with CSS:

<p><s>Today's Special: Salmon</s> SOLD OUT<br />
 <s style="text-decoration:line-through">Today's Special: Salmon</s> SOLD OUT</p>

In those cases, it would be useful to have a way to suppress the Style attributes error.

One way to do that might be win a macro; for example:

<p><s>Today's Special: Salmon</s> SOLD OUT<br />
{{DocTesterOff}}
 <s style="text-decoration:line-through">Today's Special: Salmon</s> SOLD OUT</p>
{{DocTesterOn}}

So in the example above, the {{DocTesterOff}} macro would cause the Documentation Tester to stop checking the document until it sees a {{DocTesterOn}} macro.

But that’s just an idea. I’m not wedded to any particular solution. But the problem I want to solve is that I want to be able to ensure that I can unintended errors and they don’t get obscured by errors about cases that are intentional.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions