Skip to content

Commit 0fc8464

Browse files
authored
Update usage of GenerateCmdletDesignMarkdown (#17140)
1 parent ab960b1 commit 0fc8464

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

tools/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,8 @@ This folder contains the utilities for Azure PowerShell.
2222

2323
**GenerateExternalContributors.ps1** generates the list of external contributors which is appended as part of release notes. It needs personal access token of Github with sufficient permission.
2424

25-
**GenerateCmdletDesignMarkdown.ps1** generates the cmdlet signatures for review.
25+
**GenerateCmdletDesignMarkdown.ps1** generates the cmdlet signatures for review. The content bases on generated cmdlet reference docs in markdown under docs folder. You can try below code from the root folder of your module after reference doc is generated.
26+
```
27+
..\..\tools\GenerateCmdletDesignMarkdown.ps1 -Path .\docs\ -OutPath .\docs\
28+
```
29+
Cmdldet is catorized by noun, resource type name by default, with Az prefix. `-NounPriority` is used to adjust the order of cmdlets in output.

0 commit comments

Comments
 (0)