Skip to content

Typo in documentation for the "Port" parameter. #5375

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
Jan 29, 2018
Merged

Typo in documentation for the "Port" parameter. #5375

merged 3 commits into from
Jan 29, 2018

Conversation

BrandonBoone
Copy link
Contributor

@BrandonBoone BrandonBoone commented Jan 26, 2018

In relation to this change where the "Ports" parameter was renamed to "Port": 026c016

Description


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.

In relation to this change where the "Ports" parameter was renamed to "Port": 026c016
@azuresdkci
Copy link

Can one of the admins verify this patch?

@maddieclayton
Copy link
Contributor

@azuresdkci Test this please

maddieclayton
maddieclayton previously approved these changes Jan 26, 2018
@msftclas
Copy link

msftclas commented Jan 26, 2018

CLA assistant check
All CLA requirements met.

@cormacpayne
Copy link
Member

@BrandonBoone Hey Brandon, thanks for this fix! I added another commit to your branch that updates a file that determines which tests get run based on the files changed in the PR. Apparently, it didn't include the ContainerInstance project, so your PR was running against every test rather than just ContainerInstance. I can create a separate PR with this change if you'd like your PR to be isolated from this change. Just let me know!

@BrandonBoone
Copy link
Contributor Author

@cormacpayne - Sure thing. My intent here was only to update the documentation since the code example for ContainerInstance had tripped me up. Feel free to make any other changes regarding your CI process that need to happen. I don't possess enough knowledge to meaningfully contribute in that area.

@cormacpayne
Copy link
Member

@azuresdkci test this please

@cormacpayne
Copy link
Member

@azuresdkci test this please

@markcowl markcowl merged commit 71f221e into Azure:preview Jan 29, 2018
@BrandonBoone BrandonBoone deleted the patch-1 branch January 29, 2018 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants