Skip to content
This repository was archived by the owner on Feb 24, 2021. It is now read-only.
This repository was archived by the owner on Feb 24, 2021. It is now read-only.

Wiki documentation should create code quotes for variables in parameter descriptions #337

@johlju

Description

@johlju

Details of the problem, bug, or enhancement

In the schema.mof some times we refer to values that can if set something special is happening, or if the parameter has a default value.

Example 1: Specifies if the something something. Default value is 'Present'.
Example 2: Specifies if the something something. Default value is $true.
Example 3: Specifies if the something ... when parameter X i set to 'Inbound' this must be specified.

It would look better in the WIki if these values was code quotes.

Verbose logs showing the problem (if applicable)

Not applicable

Suggested solution to the issue

Maybe we can get the auto-doc to look for words $startwithdollarsign and words 'sorroundedbyticks' and add bacticks so the would be code quotes, which would make them look like $startwithdollarsign and 'sorroundedbyticks'?

The result in the Wiki documentation will be.

Example 1: Specifies if the something something. Default value is 'Present'.
Example 2: Specifies if the something something. Default value is $true.
Example 3: Specifies if the something ... when parameter X i set to 'Inbound' this must be specified.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions