Skip to content

Commit 23e6f84

Browse files
🩹[Patch]: Test issue with break on :q! (#220)
## Description This pull request makes a minor documentation update to the `Set-PSModuleTest.ps1` script by adding a `.NOTES` section with author, date, and version information. #219
1 parent 9097aa2 commit 23e6f84

File tree

9 files changed

+37
-0
lines changed

9 files changed

+37
-0
lines changed

.github/workflows/Build-Docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ on:
3535

3636
permissions:
3737
contents: read # to checkout the repo
38+
statuses: write # to create commit status
3839

3940
jobs:
4041
Build-Docs:

tests/srcTestRepo/src/functions/public/PSModule/Get-PSModuleTest.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ function Get-PSModuleTest {
88
.SYNOPSIS
99
Performs tests on a module.
1010
11+
.DESCRIPTION
12+
Performs tests on a module.
13+
1114
.EXAMPLE
1215
Test-PSModule -Name 'World'
1316

tests/srcTestRepo/src/functions/public/PSModule/New-PSModuleTest.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ function New-PSModuleTest {
55
.SYNOPSIS
66
Performs tests on a module.
77
8+
.DESCRIPTION
9+
Performs tests on a module.
10+
811
.EXAMPLE
912
Test-PSModule -Name 'World'
1013

tests/srcTestRepo/src/functions/public/SomethingElse/Set-PSModuleTest.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
.SYNOPSIS
44
Performs tests on a module.
55
6+
.DESCRIPTION
7+
Performs tests on a module.
8+
69
.EXAMPLE
710
Test-PSModule -Name 'World'
811

tests/srcTestRepo/src/functions/public/Test-PSModuleTest.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
.SYNOPSIS
44
Performs tests on a module.
55
6+
.DESCRIPTION
7+
Performs tests on a module.
8+
69
.EXAMPLE
710
Test-PSModule -Name 'World'
811

tests/srcWithManifestTestRepo/src/functions/public/PSModule/Get-PSModuleTest.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ function Get-PSModuleTest {
88
.SYNOPSIS
99
Performs tests on a module.
1010
11+
.DESCRIPTION
12+
Performs tests on a module.
13+
1114
.EXAMPLE
1215
Test-PSModule -Name 'World'
1316

tests/srcWithManifestTestRepo/src/functions/public/PSModule/New-PSModuleTest.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ function New-PSModuleTest {
55
.SYNOPSIS
66
Performs tests on a module.
77
8+
.DESCRIPTION
9+
Performs tests on a module.
10+
811
.EXAMPLE
912
Test-PSModule -Name 'World'
1013

tests/srcWithManifestTestRepo/src/functions/public/SomethingElse/Set-PSModuleTest.ps1

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,25 @@
33
.SYNOPSIS
44
Performs tests on a module.
55
6+
.DESCRIPTION
7+
Performs tests on a module.
8+
69
.EXAMPLE
710
Test-PSModule -Name 'World'
811
912
"Hello, World!"
13+
14+
.NOTES
15+
Controls:
16+
- i : Enter INSERT mode
17+
- Esc : Enter NORMAL mode
18+
- y : Yank (copy) line
19+
- dd : Delete line
20+
- p : Paste line
21+
- :w : Save file
22+
- :q : Quit
23+
- :q! : Quit without saving
24+
- :wq : Save and quit
1025
#>
1126
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
1227
'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function',

tests/srcWithManifestTestRepo/src/functions/public/Test-PSModuleTest.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
.SYNOPSIS
44
Performs tests on a module.
55
6+
.DESCRIPTION
7+
Performs tests on a module.
8+
69
.EXAMPLE
710
Test-PSModule -Name 'World'
811

0 commit comments

Comments
 (0)