Do not append template if parameter description exists #783
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). |
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 focuses on improving the handling of parameter descriptions in the
TryGetMergedParametersmethod and adding corresponding test coverage to ensure correctness. The changes aim to refine the logic for merging descriptions and prevent boilerplate text from being appended unnecessarily.Improvements to parameter description handling:
src/Common/MergeUtils.cs: Updated theTryGetMergedParametersmethod to include a check for boilerplate descriptions usingConstants.FillInParameterDescriptionTemplate. This ensures that parameter descriptions are not concatenated with boilerplate text unless necessary.Test coverage enhancements:
test/Pester/UpdateCommandHelp.Tests.ps1: Added a test to verify that parameter descriptions are not appended with boilerplate text if the description is not boilerplate. This strengthens the validation of the updated logic inTryGetMergedParameters.PR Context
Fixes #773