Skip to content

Get-PSRuleHelp formatting suggestions #3213

@nightroman

Description

@nightroman

Get-PSRuleHelp formatting suggestions

(1) Use an empty line between paragraphs.
Without this the result wall of text is too hard to read.

(2) Consider preserving markdown marks for strong, emphasis, and especially (!) inline code spans.
The target audience is often developers well familiar with markdown.
Preserving marks may be beneficial for perception of the details.

Alternatives

If the above suggestions are not acceptable as such, please add options enabling such features. Let this be up to users.

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature: coreIssues that affect the core engine

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions