platyPS
platyPS copied to clipboard
PowerShell
Write PowerShell External Help in Markdown
Steps to reproduce ------------------ I have two function signatures, like so: ```powershell function Function1 { [CmdletBinding()] [OutputType([Void])] Param( [Parameter(Mandatory)][String] $Csv, [Parameter(Mandatory)][String][ValidateSet('Google')] $Target, [Parameter(Mandatory)][String] $TargetKey, [Parameter()][Switch] $DryRun = $false, [Parameter()][String][ValidateSet('None', 'Normal',...
Steps to reproduce ------------------ have function like this: ```powershell function ConvertTo-Type{ param( [Parameter(Position = 0,Mandatory,ValueFromPipeline,ValueFromPipelineByPropertyName,ParameterSetName='ExplicitType')] [Parameter(Position = 1,Mandatory,ValueFromPipeline,ValueFromPipelineByPropertyName,ParameterSetName='NamedType')][AllowNull()]$InputObject, [Parameter(Position = 1,Mandatory,ParameterSetName='ExplicitType')][ValidateNotNull()][type]$TargetType, [Parameter(Position = 0,Mandatory,ParameterSetName='NamedType')][ValidateNotNullOrEmpty()][string]$TargetTypeIdentifier ) process { #TODO } }...
I found an old issue from 2017 that is related to this and from what I can tell nothing has happened since. Platyps doesn't appear to detect dynamic parameters that...
Steps to reproduce ------------------ When running `New-MarkdownHelp -Module 'MyModuleName' -OutputPath .\docs`, I'm purposefully **not** using the `-Force` parameter. When doing so, I then get an error. Expected behavior ----------------- Reading...
Steps to reproduce ------------------ - Place a URL in the Comment block of a Function - Run `New-MarkdownHelp` - Run Codacity Code Analysis Expected behavior ----------------- No PSscriptanalyzer linting message...
When `New-MarkdownHelp` creates the markdown files for each cmdlet, the default set of metadata does not include the `title:` key in the YAML frontmatter. The title metadata should be set...
Our documentation uses several extended markdown styles, such as: - tables - see `Get-Help -Full Get-Date` for examples of mangled tables - Alert boxes `> [!NOTE]`, `> [!IMPORTANT]`, etc. -...
Because I'm lazy... Please, add the description of the module automaticly from the module manifest Maybe also add more info from the Module manifest, like ModuleVersion = '2.0'' Description =...
Steps to reproduce ------------------ Create a function with a comment header, and add the `.OUTPUTS` comment based help keyword. Type in the type and some descriptive text indented on the...
Steps to reproduce ------------------ Create a comment documentation with an .Example section that has more than one line of code ``` $FileContent = Get-IniContent "c:\settings.ini" C:\PS>$FileContent["Section"]["Key"] ----------- Description Returns the...
