Skip to content
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

Remove KeyVault ps1xml File from IoT Hub #4503

Merged
merged 3 commits into from
Aug 25, 2017
Merged

Conversation

chieftn
Copy link
Contributor

@chieftn chieftn commented Aug 24, 2017

Description

Removed Microsoft.Azure.Commands.IotHub.format.ps1xml and associated reference from psd. This document solely influenced the display of properties without adding additional methods. I therefore judged that no updates to documentation were applicable. If I am in error, I will happily correct. Thank you for your review!

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

  • [NA] Title of the pull request is clear and informative.
  • [Y] 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.
  • [Y] The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

  • [Y] Pull request includes test coverage for the included changes.
  • [Y] 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

  • [NA] 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.
  • [NA] Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThru parameter.

Cmdlet Parameter Guidelines

  • [Y] Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
  • [Y] 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.
  • [Y] Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

@msftclas
Copy link

@chieftn,
Thanks for your contribution as a Microsoft full-time employee or intern. You do not need to sign a CLA.
Thanks,
Microsoft Pull Request Bot

@azuresdkci
Copy link

Can one of the admins verify this patch?

@cormacpayne
Copy link
Member

@azuresdkci add to whitelist

Copy link
Member

@cormacpayne cormacpayne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chieftn one small comment, otherwise LGTM

@@ -63,7 +63,7 @@ RequiredModules = @(@{ModuleName = 'AzureRM.Profile'; ModuleVersion = '3.2.1'; }
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
FormatsToProcess = '.\Microsoft.Azure.Commands.IotHub.format.ps1xml'
#FormatsToProcess = '.\Microsoft.Azure.Commands.IotHub.format.ps1xml'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chieftn I would change this to

# FormatsToProcess = @()

for consistency across all empty/commented out attributes in this file

@chieftn
Copy link
Contributor Author

chieftn commented Aug 25, 2017

@cormacpayne -- thanks for the feedback -- updated psd to fit convention.

@cormacpayne cormacpayne merged commit d0ea9ae into Azure:preview Aug 25, 2017
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.

5 participants