From dc27213dd77fa7904ecf8939213662c3b9825f05 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Fri, 4 Sep 2026 19:30:10 +0200 Subject: [PATCH] Generalize PowerShell public help links Co-authored-by: Marius Storhaug --- 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 a2ea291..c56a024 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*. -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. +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 is an absolute HTTPS URL on the module's published documentation host and always ends in `/`: `https:////Functions//` or, for a grouped command, `https:////Functions///`. A private helper links to the published public function it supports. ### `.INPUTS` and `.OUTPUTS`