Skip to content

Rule MD04 (dollar signs before commands) #164

@s-makin

Description

@s-makin

After updating to SP 1.3.0, many pages in the Server docs are falling foul of MD04: "dollar signs used before commands without showing output".

This rule doesn't make sense when taken together with the directive to separate command and output, which we always try to follow. There are times where it makes sense to include $ (particularly when contrasted against # to illustrate different permissions required), but we shouldn't be forcing the inclusion of output in the same code block. In all the cases flagged by the check in the Server docs, the output of the command is present, but separate.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions