Confirm and WhatIf parameters should have constant descriptions #768
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
adityapatwardhan
changed the title
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
This pull request introduces changes to improve parameter description handling and corrects a typo in the
TransformUtilsclass name. It also adds unit tests to ensure proper descriptions forConfirmandWhatIfparameters. Below are the most important changes grouped by theme:Parameter Description Handling Enhancements:
src/Transform/TransformUtils.cs: Added a new methodGetParameterTemplateStringto dynamically generate parameter descriptions, including specific descriptions forConfirmandWhatIfparameters.src/Model/Constants.cs: Added constantsConfirmParameterDescriptionandWhatIfParameterDescriptionfor predefined parameter descriptions.src/Transform/TransformBase.cs: Replaced occurrences ofstring.Format(Constants.FillInParameterDescriptionTemplate, param.Name)withTransformUtils.GetParameterTemplateString(param.Name)to utilize the new method. [1] [2]Typo Fix:
src/Transform/TransformUtils.cs: Corrected the class name fromTranformUtilstoTransformUtilsand updated references accordingly. [1] [2]Unit Testing:
test/Pester/NewMarkdownHelp.Tests.ps1: Added a new test context to verify that descriptions forConfirmandWhatIfparameters are correctly generated and included in the output.PR Context
Fixes #735