Skip to content

Fix issue with Network help #3629

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

Merged
merged 3 commits into from
Mar 15, 2017
Merged

Conversation

cormacpayne
Copy link
Member

@cormacpayne cormacpayne commented Mar 14, 2017

Description

  • Fixed issue with markdown for Add/Get/New/Remove-AzureRmExpressRouteCircuitAuthorization where INPUTS and OUTPUTS sections were formatted incorrectly
  • Fixed issue with markdown for Get-AzureRmVirtualNetworkGatewayBCPPeerStatus and Get-AzureRmVirtualNetworkGatewayLearnedRoute where examples contained two code blocks that needed to be merged into one
  • Regenerated the XML help file to include these changes

This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.

General Guidelines

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
  • The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

  • Pull request includes test coverage for the included changes.
  • PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

  • New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
  • Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThru parameter.

Cmdlet Parameter Guidelines

  • Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
  • Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
  • Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

@cormacpayne
Copy link
Member Author

@lamchester @sdwheeler please take a look at this PR

It looks like when we merged Chester's PR (#3614) it reverted some of the changes that Sean made to the Network help, so I went ahead and updated the markdown for Add/Get/New/Remove-AzureRmExpressRouteCircuitAuthorization based on what previously existed.

There was also an issue with the formatting of examples in the markdown files that Chester added for the new cmdlets in his PR, so I just moved a couple of things around to stop platyPS from throwing when trying to generate the XML help from the markdown files.

Please let me know if anything jumps out.

@anavinahar
Copy link
Contributor

Update on this? @cormacpayne @lamchester @sdwheeler This is blocking changes that need to be made to PS help.

@sdwheeler
Copy link
Member

@cormacpayne @lamchester @anavinahar It looks like the content for a different cmdlet was put in these files in Chester's PR. For example, the content for Add-AzureRmApplicationGatewayUrlPathMapConfig was put into Add-AzureRmExpressRouteCircuitAuthorization.md. The corrections in this PR look good to me.

@cormacpayne cormacpayne merged commit a6c0dc9 into Azure:dev Mar 15, 2017
@cormacpayne cormacpayne deleted the fix-network-help branch May 8, 2017 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants