Ensure that commands all have Examples that show up in PowerShell help

[plastikfan]

The PowerShell help tends to be the first port of call, when unexpected things happen, so make sure that the examples are all there and comprehensive.

• All function help should have a .LINK property pointing to github site. Eventually, these will point to ghpages.
• For manadatory parameters, make sure there is a HelpMessage attribute in the parameter definition eg: HelpMessage = "Enter a unique name for the widget.")
• The .md file must have a paragraph titled ##EXAMPLES in order for the examples to come out, otherwise they are ignored
• The code snippet must be inside a backticked labelled code block (```powershell)
• The example text must come after the code block. Text before it is ignored
• Any parameter bound to pipeline item should be marked in the INPUTS section

[plastikfan]

Rename-Many already has lots of examples but they don't show up in Get-Help

get-help rename-many -Examples

just shows:

NAME
    Rename-Many

SYNOPSIS
    Performs a bulk rename for all file system objects delivered through the pipeline, via regular expression replacement.

Plastikfan@JANUS  ~\dev\github\PoSh\Loopz\Elizium.Loopz   feature/doc-examples ≢                                                                                                      [12:06]
λ get-help rename-many -Examples

NAME
    Rename-Many

SYNOPSIS
    Performs a bulk rename for all file system objects delivered through the pipeline, via regular expression replacement.

In the xml file

    <command:details>
      <command:name>Rename-Many</command:name>
      <command:verb>Rename</command:verb>
      <command:noun>Many</command:noun>
      <maml:description>
        <maml:para>Performs a bulk rename for all file system objects delivered through the pipeline, via regular expression replacement.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
...
      <maml:para>---</maml:para>
      <maml:para>* MOVE EXAMPLES (anchored)</maml:para>
      <maml:para>.EXAMPLE 1 Move a static string before anchor (consider file items only):</maml:para>
      <maml:para>gci ... | Rename-Many -File -Pattern 'data' -Anchor 'loopz' -Relation 'before'</maml:para>
      <maml:para>.EXAMPLE 2 Move last occurrence of whole-word static string before anchor:</maml:para>
      <maml:para>gci ... | Rename-Many -Pattern 'data',l -Anchor 'loopz' -Relation 'before' -Whole p</maml:para>
...

so the examples are there, but just not showing up for some reason.

[plastikfan]

See:

• Troubleshooting Comment-Based Help
• platyPS Schema