Skip to content

Update rule description to the latest template #5458

@jelly

Description

@jelly

In my PR I was using the old template which I copied from another rule, the new template shows the Bad and Good examples different.

There are still rules around which use the old template i.e.:

    /// ### Example
    /// ```jsx
    /// // Bad
    /// <html />
    ///
    /// // Good
    /// <html lang="en" />
    /// ```

They can be found with:

git grep "\/\/ Bad"

And one uses a different template:

crates/oxc_linter/src/rules/typescript/no_useless_empty_export.rs: /// ### Bad

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-linterArea - LinterC-docsCategory - Documentation. Related to user-facing or internal documentationgood first issueExperience Level - Good for newcomers

    Type

    No type

    Priority

    None yet

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions