Updated comment based help for Get-ShlinkVisits

codaamok · Apr 23, 2022 · 4071850 · 4071850
1 parent 8c0ea0b
commit 4071850
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -23,7 +23,7 @@
             "label": "Build (with docs)",
             "type": "process",
             "command": "pwsh",
-            "args": ["-noprofile","-command","Invoke-Build","-File","./invoke.build.ps1","-Author","'codaamok'","-ModuleName","'PSShlink'","-UpdateDocs"],
+            "args": ["-noprofile","-command","Invoke-Build","-File","./invoke.build.ps1","-Author","'codaamok'","-ModuleName","'PSShlink'","-UpdateDocs","$true"],
             "group": {
                 "kind": "build",
                 "isDefault": true

diff --git a/docs/Get-ShlinkVisits.md b/docs/Get-ShlinkVisits.md
@@ -68,6 +68,13 @@ Get-ShlinkVisits -ShortCode "profile" -StartDate (Get-Date "2020-11-01") -EndDat
 
 Returns all visit data associated with the short code "profile" for the whole of November 2020
 
+### EXAMPLE 5
+```
+Get-ShlinkVisits -Domain "contoso.com"
+```
+
+Returns all visit data associated with the domain "contoso.com"
+
 ## PARAMETERS
 
 ### -ShortCode

diff --git a/src/Public/Get-ShlinkVisits.ps1 b/src/Public/Get-ShlinkVisits.ps1
@@ -39,6 +39,10 @@ function Get-ShlinkVisits {
         PS C:\> Get-ShlinkVisits -ShortCode "profile" -StartDate (Get-Date "2020-11-01") -EndDate (Get-Date "2020-12-01")
 
         Returns all visit data associated with the short code "profile" for the whole of November 2020
+    .EXAMPLE
+        PS C:\> Get-ShlinkVisits -Domain "contoso.com"
+
+        Returns all visit data associated with the domain "contoso.com"
     .INPUTS
         This function does not accept pipeline input.
     .OUTPUTS