Get-PSRuleHelp formatting suggestions
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 474
- Forks
- 65
- Avg merge
- 22h 25m
- Merged PRs (30d)
- 26
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Get-PSRuleHelp entry point and tracing how its help text is formatted. Compare the current paragraph and inline-mark rendering with the requested behavior, then determine whether preserving markdown or adding user options best fits the alternatives. Done means the output is easier to read and the chosen behavior is covered by the relevant help functionality.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100