Skip to content

Commit 22bb5a0

Browse files
BernieWhitevors
authored andcommitted
Help cleanup of trailing spaces and line breaks (#324)
1 parent f4543c5 commit 22bb5a0

11 files changed

+62
-66
lines changed

docs/Get-HelpPreview.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Specifies an array of paths of MAML external help files.
5151
```yaml
5252
Type: String[]
5353
Parameter Sets: (All)
54-
Aliases:
54+
Aliases:
5555

5656
Required: True
5757
Position: Named
@@ -67,7 +67,7 @@ This output follows TechNet formatting.
6767
```yaml
6868
Type: SwitchParameter
6969
Parameter Sets: (All)
70-
Aliases:
70+
Aliases:
7171

7272
Required: False
7373
Position: Named
@@ -84,7 +84,7 @@ Markdown accepts single-hyphens for lists.
8484
```yaml
8585
Type: SwitchParameter
8686
Parameter Sets: (All)
87-
Aliases:
87+
Aliases:
8888

8989
Required: False
9090
Position: Named
@@ -109,4 +109,3 @@ This cmdlet returns a **Help** object, which is the same output as **Get-Help**.
109109
## NOTES
110110
111111
## RELATED LINKS
112-

docs/Get-MarkdownMetadata.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Specifies an array of paths of markdown files or folders.
9696
```yaml
9797
Type: String[]
9898
Parameter Sets: FromPath
99-
Aliases:
99+
Aliases:
100100

101101
Required: True
102102
Position: Named
@@ -112,7 +112,7 @@ Specifies a string that contains markdown formatted text.
112112
```yaml
113113
Type: String
114114
Parameter Sets: FromMarkdownString
115-
Aliases:
115+
Aliases:
116116

117117
Required: True
118118
Position: Named
@@ -138,4 +138,3 @@ The dictionary contains key-value pairs found in the markdown metadata block.
138138
## NOTES
139139
140140
## RELATED LINKS
141-

docs/Merge-MarkdownHelp.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: platyPS-help.xml
33
Module Name: platyPS
4-
online version:
4+
online version:
55
schema: 2.0.0
66
---
77

@@ -58,7 +58,7 @@ For more information, see [Using PowerShell to write a file in UTF-8 without the
5858
```yaml
5959
Type: Encoding
6060
Parameter Sets: (All)
61-
Aliases:
61+
Aliases:
6262

6363
Required: False
6464
Position: Named
@@ -74,7 +74,7 @@ By default cmdlets and parameters that are present in all variations don't get a
7474
```yaml
7575
Type: SwitchParameter
7676
Parameter Sets: (All)
77-
Aliases:
77+
Aliases:
7878

7979
Required: False
8080
Position: Named
@@ -89,7 +89,7 @@ Indicates that this cmdlet overwrites an existing file that has the same name.
8989
```yaml
9090
Type: SwitchParameter
9191
Parameter Sets: (All)
92-
Aliases:
92+
Aliases:
9393

9494
Required: False
9595
Position: Named
@@ -105,7 +105,7 @@ Applicable tag list would be included after the marker
105105
```yaml
106106
Type: String
107107
Parameter Sets: (All)
108-
Aliases:
108+
Aliases:
109109

110110
Required: False
111111
Position: 3
@@ -120,7 +120,7 @@ Specifies the path of the folder where this cmdlet creates the combined markdown
120120
```yaml
121121
Type: String
122122
Parameter Sets: (All)
123-
Aliases:
123+
Aliases:
124124

125125
Required: True
126126
Position: 1
@@ -136,7 +136,7 @@ This cmdlet creates combined markdown help based on these files and folders.
136136
```yaml
137137
Type: String[]
138138
Parameter Sets: (All)
139-
Aliases:
139+
Aliases:
140140

141141
Required: True
142142
Position: 0
@@ -159,4 +159,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
159159
## NOTES
160160
161161
## RELATED LINKS
162-

docs/New-ExternalHelp.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ The folder name should end with a locale folder, as in the following example: `.
8282
```yaml
8383
Type: String
8484
Parameter Sets: (All)
85-
Aliases:
85+
Aliases:
8686

8787
Required: True
8888
Position: Named
@@ -102,7 +102,7 @@ For more information, see [Using PowerShell to write a file in UTF-8 without the
102102
```yaml
103103
Type: Encoding
104104
Parameter Sets: (All)
105-
Aliases:
105+
Aliases:
106106

107107
Required: False
108108
Position: Named
@@ -117,7 +117,7 @@ Indicates that this cmdlet overwrites an existing file that has the same name.
117117
```yaml
118118
Type: SwitchParameter
119119
Parameter Sets: (All)
120-
Aliases:
120+
Aliases:
121121

122122
Required: False
123123
Position: Named
@@ -133,7 +133,7 @@ This cmdlet creates external help based on these files and folders.
133133
```yaml
134134
Type: String[]
135135
Parameter Sets: (All)
136-
Aliases:
136+
Aliases:
137137

138138
Required: True
139139
Position: Named
@@ -153,7 +153,7 @@ See [design issue](https://github.com/PowerShell/platyPS/issues/273) for more de
153153
```yaml
154154
Type: String[]
155155
Parameter Sets: (All)
156-
Aliases:
156+
Aliases:
157157
158158
Required: False
159159
Position: Named
@@ -173,7 +173,7 @@ MaxAboutWidth parameter.
173173
```yaml
174174
Type: Int32
175175
Parameter Sets: (All)
176-
Aliases:
176+
Aliases:
177177
178178
Required: False
179179
Position: Named
@@ -194,7 +194,7 @@ If this path is not provided, no log will be generated.
194194
```yaml
195195
Type: String
196196
Parameter Sets: (All)
197-
Aliases:
197+
Aliases:
198198
199199
Required: False
200200
Position: Named

docs/New-ExternalHelpCab.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Specifies the folder that contains the help content that this cmdlet packages in
5050
```yaml
5151
Type: String
5252
Parameter Sets: (All)
53-
Aliases:
53+
Aliases:
5454

5555
Required: True
5656
Position: Named
@@ -67,7 +67,7 @@ For the required metadata, run **New-MarkdownHelp** with the *WithLandingPage* p
6767
```yaml
6868
Type: String
6969
Parameter Sets: (All)
70-
Aliases:
70+
Aliases:
7171

7272
Required: True
7373
Position: Named
@@ -83,7 +83,7 @@ Specifies the location of the .cab file and helpinfo.xml file that this cmdlet c
8383
```yaml
8484
Type: String
8585
Parameter Sets: (All)
86-
Aliases:
86+
Aliases:
8787

8888
Required: True
8989
Position: Named
@@ -98,7 +98,7 @@ Automatically increment the help version in the module markdown file.
9898
```yaml
9999
Type: SwitchParameter
100100
Parameter Sets: (All)
101-
Aliases:
101+
Aliases:
102102

103103
Required: False
104104
Position: Named

docs/New-MarkdownAboutHelp.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The name of the about topic.
6565
```yaml
6666
Type: String
6767
Parameter Sets: (All)
68-
Aliases:
68+
Aliases:
6969

7070
Required: False
7171
Position: 1
@@ -80,7 +80,7 @@ The directory to create the about topic in.
8080
```yaml
8181
Type: String
8282
Parameter Sets: (All)
83-
Aliases:
83+
Aliases:
8484

8585
Required: True
8686
Position: 0

0 commit comments

Comments
 (0)