Skip to content

🚀 [Idea]: Support adding titles to examples #627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MariusStorhaug opened this issue Mar 25, 2024 · 1 comment
Closed

🚀 [Idea]: Support adding titles to examples #627

MariusStorhaug opened this issue Mar 25, 2024 · 1 comment
Labels
Idea-Helpv2 Issue-Enhancement Issue is more of a feature request than a bug

Comments

@MariusStorhaug
Copy link

MariusStorhaug commented Mar 25, 2024

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:

<#
    .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
...

Proposed technical implementation details (optional)

No response

@MariusStorhaug MariusStorhaug added Issue-Enhancement Issue is more of a feature request than a bug Needs-Triage The issue is new and needs to be triaged by a work group. labels Mar 25, 2024
@sdwheeler
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Idea-Helpv2 Issue-Enhancement Issue is more of a feature request than a bug
Projects
None yet
Development

No branches or pull requests

2 participants