Skip to content

fix(linting): move comment-based help blocks inside functions #32

@WilliamBerryiii

Description

@WilliamBerryiii

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

  1. Help block for Get-MarkdownTarget at line 41 is outside the function
  2. Help block for Get-RelativePrefix at 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationlintingLinting rules and validationpriority-3Medium priority, standard queuescriptsPowerShell, Bash, or Python scripts

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions