Skip to content

Commit 39411c5

Browse files
📖 [Docs]: Generated PowerShell help URLs now use trailing slashes (#92)
PowerShell module authors now have one unambiguous canonical form for generated online help links, preventing `.LINK` URLs from alternating between equivalent-looking routes. ## Changed: Generated function help links use trailing slashes Every public function now uses its generated online reference URL as the first `.LINK` entry. Both ungrouped and grouped URL examples explicitly end in `/`; private-helper guidance is unchanged. ## Technical Details - Updated only `src/docs/Coding-Standards/PowerShell/Functions.md`. - Aligns the shared standard with the canonical generated help routes adopted in PSModule/Domeneshop commit `41f39ca521652c022aaa2ca940adf45f81067a2e`. - Documentation index verification, link validation, and a clean Zensical build are complete. <details> <summary>Related issues</summary> - PSModule/Domeneshop#16 </details> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 3e04c26 commit 39411c5

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

‎src/docs/Coding-Standards/PowerShell/Functions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Send each kind of message to the stream built for it, so a caller can capture, r
115115

116116
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*.
117117

118-
Functions in modules built with the PSModule framework use the generated online reference URL in `.LINK`: `https://psmodule.io/<ModuleName>/Functions/<Function-Name>` or, for a grouped command, `https://psmodule.io/<ModuleName>/Functions/<Group>/<Function-Name>`. A private helper links to the published public function it supports.
118+
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/<ModuleName>/Functions/<Function-Name>/` or, for a grouped command, `https://psmodule.io/<ModuleName>/Functions/<Group>/<Function-Name>/`. A private helper links to the published public function it supports.
119119

120120
### `.INPUTS` and `.OUTPUTS`
121121

0 commit comments

Comments
 (0)