Skip to content

Lint description Markdown strings for… #1935

@ddbeck

Description

@ddbeck

We ought to wire up a tool like https://github.com/remarkjs/remark-lint to check for style and consistency in description strings.

Some things we ought to check for:

  • Spaces around in code (as in for … of, not for…of)
  • Enclose HTML tags in backticks (as in The `<body>` element…, not "The <body> element…")
  • Double (or more) spaces (e.g., Don't let this→ ←happen)

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesttools and infrastructureProject internal tooling, such as linters, GitHub Actions, or repo settings

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions