task UpdateCBH: Bug fixed in updating Comment Based Help in functions to point to external help - #10
Merged
Conversation
added 4 commits
March 29, 2018 14:14
Bug fixed in updating Comment Based Help in functions to point to external help
The Issue: If we have multiple <# … #> Comments like the following situation, then everything between the first <# and the last #> was replaced by the single one external help link:
Function Set-FileContent-Encoded() {
<#
.SYNOPSIS
…
#>
[CmdletBinding()]
Param (
…
)
Function ConvertHashtableTo-Object {
<#
.SYNOPSIS
…
#>
…
}
}
The Fix recognizes multiple Comment Based Help texts <# … #> correctly and replaces only the first one with the link to the external help
$Description can now contain Newlines / multiple Lines, they are properly indented.
$Description can now contain Newlines / multiple Lines, they are properly indented.
$Description can now contain Newlines / multiple Lines, they are properly indented.
zloeber
approved these changes
Mar 31, 2018
zloeber
pushed a commit
that referenced
this pull request
Apr 24, 2020
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The Issue: If we have multiple <# … #> Comments like the following situation, then everything between the first <# and the last #> was replaced by the single one external help link:
The Fix:
<# … #>correctly and replaces only the first found Comment Based Help texts with the link to the external help.