You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Changes for comment based help: Should support adding a string after .EXAMPLE. This text is the title of the test.
The title gets transferred to the markdown, by simply appending it behind ## Example 1: <Title>.
From the powershell script/module/function:
<# .EXAMPLE Adding a title to the example ... .EXAMPLE Showing more examples with titles ...#>
The generated markdown:
...
## Examples### Example 1: Adding a title to the example
...
### Example 2: Showing more examples with titles
...
This is a feature request for PowerShell. The PowerShell engine that implements comment-based help would need to support this before PlatyPS could do anything with it. Please file an issue with the PowerShell team.
Summary of the new feature / enhancement
Support adding titles to examples.
Changes for comment based help: Should support adding a string after
.EXAMPLE
. This text is the title of the test.The title gets transferred to the markdown, by simply appending it behind
## Example 1: <Title>
.From the powershell script/module/function:
The generated markdown:
Proposed technical implementation details (optional)
No response
The text was updated successfully, but these errors were encountered: