Skip to content

Conversation

@madewithsmiles
Copy link
Contributor

Description

Checklist

  • [X ] I have read the Submitting Changes section of CONTRIBUTING.md
  • The title of the PR is clear and informative
  • The appropriate ChangeLog.md file(s) has been updated:
    • For any service, the ChangeLog.md file can be found at src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
    • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header -- no new version header should be added
  • The PR does not introduce breaking changes
  • If applicable, the changes made in the PR have proper test coverage
  • For public API changes to cmdlets:
    • a cmdlet design review was approved for the changes in this repository (Microsoft internal only)
    • the markdown help files have been regenerated using the commands listed here

@isra-fel
Copy link
Member

isra-fel commented Aug 3, 2020

Hi Beisi could you help review this PR? Thanks

public string Name { get; set; }

[Parameter(
ParameterSetName = "DefaultParameter",
Copy link
Contributor

Choose a reason for hiding this comment

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

It would be better if gives some help messages

Copy link
Member

Choose a reason for hiding this comment

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

The common practice is to write parameter description (aka help message) in the [Parameter()] attribute. When generating help it will be written to the markdown files.

However it's also OK (though not recomended) to manually update the help file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Understood. Thank you.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will make some updates and submit a PR fixing that

@BethanyZhou
Copy link
Contributor

Looks good to me. Leaves 1 comment

@isra-fel isra-fel merged commit 91b7b61 into Azure:master Aug 3, 2020
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.

3 participants