Fix Get-Help for advanced functions with MAML help content
#8353
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
TravisEz13
approved these changes
Nov 28, 2018
adityapatwardhan
changed the title
Get-Help for advanced functions with MAML help content
adityapatwardhan
added
the
CL-General
TravisEz13
approved these changes
Nov 30, 2018
The name of the module and hence the help file name change in PSReadline version 2. The cab and the zip files have the latest help content.
The updatable help content is not correct for PSReadLine module due to issue PowerShell/PSReadLine#819 Removed the module from help testing. Also enabling tests for Microosoft.PowerShell.Archive covers the scenarios PSReadLine module was used for.
adityapatwardhan
force-pushed
the
UpdateStaticHelpContent
branch
from
c272f3d to
4d139c1
Compare
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.
PR Summary
If a module has advanced function and the help defined in MAML then the help file was not found under user scope.
This change updates the logic to look in a sub-folder for the module name under user scope help root.
Also enabled tests for
Microsoft.PowerShell.Archivemodule and removed tests for PSReadLine.PSReadLine tests were removed as the updatable help content does not have the latest help for v2.0.0
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:to the beginning of the title and remove the prefix when the PR is ready.[feature]if the change is significant or affects feature tests