Skip to content

Commit a920bc8

Browse files
author
Maddie Clayton
authored
Update help-generation.md
1 parent 807103a commit a920bc8

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

documentation/development-docs/help-generation.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ All MAML files containing the help content for cmdlets have been removed from th
66

77
## Installing `platyPS`
88

9-
In order to use the cmdlets necessary to update the markdown help files (or generate MAML help locally from these markdown files), you must first install the `platyPS` module mentioned previously.
9+
In order to use the cmdlets necessary to update the markdown help files (or generate MAML help locally from these markdown files), you must first install the `platyPS` module mentioned previously. You will need to install a minimum version of 0.11.0.
1010

1111
To do so, you can can follow the below steps (which are outlined in the [**Quick start**](https://github.com/PowerShell/platyPS#quick-start) section of the `platyPS` README):
1212

@@ -62,13 +62,10 @@ $PathToModuleManifest = "../../<module.psd1" # Full path to the module manifest
6262
Import-Module -Name $PathToModuleManifest
6363
6464
$PathToHelpFolder = "../../help" # Full path to help folder containing markdown files to be updated
65-
Update-MarkdownHelpModule -Path $PathToHelpFolder -RefreshModulePage -AlphabeticParamsOrder
65+
Update-MarkdownHelpModule -Path $PathToHelpFolder -RefreshModulePage -AlphabeticParamsOrder -UseFullTypeName
6666
```
6767

68-
Because the -UseFullTypeName parameter is not yet available in Update-MarkdownHelpModule (it will be enabled in the upcoming release of PlatyPS), you will need to run this command to modify the help files to use full type names:
69-
```
70-
Get-ChildItem -Path $PathToHelpFolder | Update-MarkdownHelp -AlphabeticParamsOrder -UseFullTypeName
71-
```
68+
If you would like to update the inputs/outputs for a markdown file, please run this cmdlet with the -UpdateInputOutput parameter. Keep in mind that this will overwrite any customized descriptions of inputs and outputs, so you will need to add these descriptions back if still relevant.
7269

7370
This will update all of the markdown files with public interface changes made to corresponding cmdlets, add markdown files for any new cmdlets, remove markdown files for any deleted cmdlets, and update the module page (_e.g.,_ `AzureRM.Profile.md`) with any added or removed cmdlets.
7471

@@ -84,6 +81,8 @@ $PathToMarkdownFile = "../../<cmdlet>.md" # Full path to the markdown file to be
8481
Update-MarkdownHelp -Path $PathToMarkdownFile -AlphabeticParamsOrder -UseFullTypeName
8582
```
8683

84+
If you would like to update the inputs/outputs for a markdown file, please run this cmdlet with the -UpdateInputOutput parameter. Keep in mind that this will overwrite any customized descriptions of inputs and outputs, so you will need to add these descriptions back if still relevant.
85+
8786
#### Generating and viewing the MAML help
8887

8988
During the build, the MAML help will be generated from the markdown files in the repository. If you would like to generate the MAML help and preview what the help content will look like for each of your cmdlets, you can do so with two more commands.

0 commit comments

Comments
 (0)