-
Notifications
You must be signed in to change notification settings - Fork 125
Closed
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationlintingLinting rules and validationLinting rules and validationpriority-3Medium priority, standard queueMedium priority, standard queuescriptsPowerShell, Bash, or Python scriptsPowerShell, Bash, or Python scripts
Description
Issue Description
Comment-based help blocks are placed outside their respective functions, which prevents Get-Help from working correctly.
File: scripts/linting/Markdown-Link-Check.ps1
Lines: 41 and 106
Problem
- Help block for
Get-MarkdownTargetat line 41 is outside the function - Help block for
Get-RelativePrefixat line 106 is outside the function
Expected Fix
Move each .SYNOPSIS/.DESCRIPTION/.PARAMETER block inside its respective function, immediately after the function declaration.
Impact
- Severity: Low
- Get-Help cmdlet won't display function documentation
- Affects developer experience and maintainability
Source
Identified in PR #26 code review.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationlintingLinting rules and validationLinting rules and validationpriority-3Medium priority, standard queueMedium priority, standard queuescriptsPowerShell, Bash, or Python scriptsPowerShell, Bash, or Python scripts