From aaff5644b7f6b9da3005b679943515df9b70c7b3 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 26 Jul 2026 00:59:15 +0200 Subject: [PATCH] Clarify canonical PowerShell help URLs Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- src/docs/Coding-Standards/PowerShell/Functions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/Coding-Standards/PowerShell/Functions.md b/src/docs/Coding-Standards/PowerShell/Functions.md index 88b3d02..a2ea291 100644 --- a/src/docs/Coding-Standards/PowerShell/Functions.md +++ b/src/docs/Coding-Standards/PowerShell/Functions.md @@ -115,7 +115,7 @@ Send each kind of message to the stream built for it, so a caller can capture, r Every function carries comment-based help — including internal and private helpers, not only the public surface. It is what lets a reader or an agent understand what the function does and how to call it without reading its body, and a private helper needs that as much as a public command does. Put it first inside the body, with sections in this order: `.SYNOPSIS` (one imperative sentence), `.DESCRIPTION`, at least one `.EXAMPLE` per behaviour, then `.INPUTS`, `.OUTPUTS` (matching `[OutputType()]`), `.NOTES`, `.LINK`. Document each parameter with an inline comment above it rather than a `.PARAMETER` block, and let comments explain *why*, not *what*. -Functions in modules built with the PSModule framework use the generated online reference URL in `.LINK`: `https://psmodule.io//Functions/` or, for a grouped command, `https://psmodule.io//Functions//`. A private helper links to the published public function it supports. +Every public function in a module built with the PSModule framework uses its generated online reference URL as the first `.LINK` entry. The canonical URL always ends in `/`: `https://psmodule.io//Functions//` or, for a grouped command, `https://psmodule.io//Functions///`. A private helper links to the published public function it supports. ### `.INPUTS` and `.OUTPUTS`