GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Fix `Get-Help` for advanced functions with MAML help content by adityapatwardhan · Pull Request #8353 · PowerShell/PowerShell

Conversation

@adityapatwardhan

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) commented Nov 28, 2018 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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.Archive module 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

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Change is not breaking
  • Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.
  • User-facing changes
    • Not Applicable
    • OR
    • User-facing Documentation needed
      • Issue filed - Issue link:
  • Testing - New and feature
    • Not Applicable or can only be tested interactively
    • OR
    • Make sure you've added a new test if existing tests do not effectively test the code changed
      • Add [feature] if the change is significant or affects feature tests

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@adityapatwardhan
Aditya Patwardhan (adityapatwardhan) requested a review from Travis Plunk (TravisEz13) November 28, 2018 22:33
TravisEz13
Travis Plunk (TravisEz13) approved these changes Nov 28, 2018
View reviewed changes
@adityapatwardhan
Aditya Patwardhan (adityapatwardhan) requested a review from Francisco Gamino (Francisco-Gamino) as a code owner November 29, 2018 23:50
@adityapatwardhan Aditya Patwardhan (adityapatwardhan) changed the title Update the static test content for PSReadline v2 Fix Get-Help for advanced functions with MAML help content Nov 29, 2018
@adityapatwardhan Aditya Patwardhan (adityapatwardhan) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Nov 29, 2018
TravisEz13
Travis Plunk (TravisEz13) approved these changes Nov 30, 2018
View reviewed changes
Aditya Patwardhan (adityapatwardhan) added 8 commits November 29, 2018 17:28
@adityapatwardhan
Update the static test content for PSReadline v2
573aa3d 
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.
@adityapatwardhan
Fix tests to expect the new file name
7344142
@adityapatwardhan
[Feature] Add the about help file to the list of expected help files
9b30c87
@adityapatwardhan
[Feature] Remove PSReadLine module from help tests
d264e0d 
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
Update help content for Microsoft.PowerShell.Archive and update tests
e04fdbc
@adityapatwardhan
[Feature] Fix issue in Get-Help where MAML help for advanced function…
5916e8d 
…s is not shown
@adityapatwardhan
[Feature] CodeFactor fixes
c2707ca
@adityapatwardhan
[Feature] Added null check for moduleName
4d139c1
@adityapatwardhan
Aditya Patwardhan (adityapatwardhan) force-pushed the UpdateStaticHelpContent branch from c272f3d to 4d139c1 Compare November 30, 2018 01:53
@adityapatwardhan
Aditya Patwardhan (adityapatwardhan) merged commit 13e2559 into PowerShell:master Nov 30, 2018
@adityapatwardhan
Aditya Patwardhan (adityapatwardhan) deleted the UpdateStaticHelpContent branch November 30, 2018 17:49
@iSazonov Ilya (iSazonov) assigned Aditya Patwardhan (adityapatwardhan) Dec 8, 2018
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@adityapatwardhan
Fix Get-Help for advanced functions with MAML help content (PowerSh…
2a57d6f 
…ell#8353)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TravisEz13 Travis Plunk (TravisEz13) TravisEz13 approved these changes
@Francisco-Gamino Francisco Gamino (Francisco-Gamino) Awaiting requested review from Francisco-Gamino

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@adityapatwardhan Aditya Patwardhan (adityapatwardhan)

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@adityapatwardhan @TravisEz13
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.