Skip to content

Commit 6d56750

Browse files
Add .LINK sections to public function documentation (#12)
## Summary This PR adds `.LINK` sections to the comment-based help for public functions, pointing to the repository's GitHub Pages documentation. ## Changes - **Get-Greeting.ps1**: Added `.LINK` section pointing to `https://MariusStorhaug.github.io/MariusTestModule/Functions/Get-Greeting/` - **Get-PSModuleTest.ps1**: Added `.LINK` section pointing to `https://MariusStorhaug.github.io/MariusTestModule/Functions/Get-PSModuleTest/` ## Benefits - Users can easily access online documentation via `Get-Help <FunctionName>` output - Provides a direct reference to comprehensive documentation on GitHub Pages
1 parent ff97ef8 commit 6d56750

3 files changed

Lines changed: 7 additions & 0 deletions

File tree

.github/workflows/Process-PSModule.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,4 @@ jobs:
3030
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@releasenotes
3131
secrets:
3232
APIKey: ${{ secrets.APIKey }}
33+

src/functions/public/Get-Greeting.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
Get-Greeting -TimeOfDay 'Morning'
1111
1212
Returns "Good Morning!"
13+
14+
.LINK
15+
https://MariusStorhaug.github.io/MariusTestModule/Functions/Get-Greeting/
1316
#>
1417
[OutputType([string])]
1518
[CmdletBinding()]

src/functions/public/Get-PSModuleTest.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
```
1313
1414
"Hello, World!"
15+
16+
.LINK
17+
https://MariusStorhaug.github.io/MariusTestModule/Functions/Get-PSModuleTest/
1518
#>
1619
[CmdletBinding()]
1720
param (

0 commit comments

Comments
 (0)