-
Notifications
You must be signed in to change notification settings - Fork 4k
Adding aliases to a few cmdlets and updating help documentation to match #4110
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -182,5 +182,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable | |
|
||
## RELATED LINKS | ||
|
||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -150,5 +150,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable | |
|
||
## RELATED LINKS | ||
|
||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -129,5 +129,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable | |
|
||
## RELATED LINKS | ||
|
||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -132,5 +132,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable | |
|
||
## RELATED LINKS | ||
|
||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -113,5 +113,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable | |
|
||
## RELATED LINKS | ||
|
||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -114,7 +114,7 @@ Specifies the name of the database. | |
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
Aliases: Name | ||
|
||
Required: True | ||
Position: Named | ||
|
@@ -169,7 +169,7 @@ Specifies the maximum size of the database in bytes. | |
```yaml | ||
Type: Int64 | ||
Parameter Sets: (All) | ||
Aliases: | ||
Aliases: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: remove? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is auto generated so I'd rather leave it. |
||
|
||
Required: False | ||
Position: Named | ||
|
@@ -224,6 +224,22 @@ Accept pipeline input: True (ByPropertyName) | |
Accept wildcard characters: False | ||
``` | ||
|
||
### -SampleName | ||
The name of the sample schema to apply when creating this database. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
Accepted values: AdventureWorksLT | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### -ServerName | ||
Specifies the name of the server that hosts the database. | ||
|
||
|
@@ -285,24 +301,8 @@ Accept pipeline input: False | |
Accept wildcard characters: False | ||
``` | ||
|
||
### -SampleName | ||
The name of the sample schema to apply when creating this database. | ||
|
||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: False | ||
Position: Named | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
|
||
### CommonParameters | ||
|
||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @cormacpayne how do I make the generated markdown include the missing '[' and ']' ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @akromm it does not appear to be There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @akromm I'd have to look, but I think a previously opened PR made the change to wrap the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @cormacpayne correct, a previous PR added in the enclosed brackets to make the text a link. I would like to keep it that way during future re-generation of the doc files. What are your thoughts? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @akromm I agree, it would make it much nicer to view in markdown. I can also talk to the |
||
|
||
## INPUTS | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akromm I think this was a change that was recently made. Do we want to revert it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, thank you for catching. Where is the source for this comment? I'd like to change it at the source so that future re-generation of this file doesn't cause this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akromm I was under the impression that this was the source. Do you remember the command you used to regenerate the markdown help?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cormacpayne I used platyPS:
$pathToHelpFolder = "E:\git\azure-powershell\src\ResourceManager\Sql\Commands.Sql\help"
Update-MarkdownHelpModule -Path $PathToHelpFolder -RefreshModulePage -AlphabeticParamsOrder
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akromm that's the correct command. I would assume this is an issue with how
platyPS
parses the markdown (maybe it can't handle links?). I can investigate myself and open an issue in their repository if necessary.