Makes corrections to one of the examples in the Set-JiraUser cmdlet documentation and adds a note to the documentation for the -Property parameter of that cmdlets regarding accepted capitalization of user property names.
Motivation and Context
Fixes #508
This resolves a mistake in the example code and provides important information about the camel case capitalization that is required by the JIRA API. Without this information users may attempt to submit property changes using a different capitalization format (e.g. Pascal case which is used in the objects returned by the various Get- cmdlets in JiraPS). Using the wrong capitalization may result in a No value found to be changed. error being returned.
Types of changes
[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
Checklist
[ ] My code follows the code style of this project.
[ ] I have added Pester Tests that describe what my changes should do.
Description
Makes corrections to one of the examples in the Set-JiraUser cmdlet documentation and adds a note to the documentation for the -Property parameter of that cmdlets regarding accepted capitalization of user property names.
Motivation and Context
Fixes #508
This resolves a mistake in the example code and provides important information about the camel case capitalization that is required by the JIRA API. Without this information users may attempt to submit property changes using a different capitalization format (e.g. Pascal case which is used in the objects returned by the various Get- cmdlets in JiraPS). Using the wrong capitalization may result in a
No value found to be changed.error being returned.Types of changes
Checklist