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 — Display full help with 'help' function by rkeithhill · Pull Request #5195 · PowerShell/PowerShell

Conversation

@rkeithhill

@rkeithhill Keith Hill (rkeithhill) commented Oct 21, 2017

Copy link
Copy Markdown
Collaborator

Display full help on Windows systems where user has overriden pager with $env:PAGER.

Fix #4962

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@rkeithhill
Keith Hill (rkeithhill) requested review from Bruce Payette (BrucePay), Dongbo Wang (daxian-dbw), Jason Shirk (lzybkr) and sergei (vors) as code owners October 21, 2017 22:32
@SteveL-MSFT
Steve Lee (SteveL-MSFT) requested a review from Aditya Patwardhan (adityapatwardhan) October 22, 2017 01:00
@SteveL-MSFT Steve Lee (SteveL-MSFT) assigned Aditya Patwardhan (adityapatwardhan) Oct 22, 2017
@rkeithhill

Keith Hill (rkeithhill) commented Oct 26, 2017

Copy link
Copy Markdown
Collaborator Author

Any chance of something like this making it in before 6.0.0 final? It would be nice to offer full help to Linux users. And to Windows users who elect to set $env:PAGER to a better pager app. :-)
All reactions

Sorry, something went wrong.

Uh oh!

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

Aditya Patwardhan (adityapatwardhan) commented Oct 26, 2017

Copy link
Copy Markdown
Member

Keith Hill (@rkeithhill) Sorry for the delay. I will review this today.
All reactions

Sorry, something went wrong.

Uh oh!

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

Keith Hill (rkeithhill) commented Oct 26, 2017

Copy link
Copy Markdown
Collaborator Author

No problem. You all had a big push to get beta.9 out.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
adityapatwardhan
Aditya Patwardhan (adityapatwardhan) requested changes Oct 26, 2017
View reviewed changes
Comment thread src/System.Management.Automation/engine/InitialSessionState.cs Outdated

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) Oct 26, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a test which check the view that gets selected. It should have #FullView

(Get-Help Get-Command -Full).psobject.typenames

Sorry, something went wrong.

Uh oh!

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

@rkeithhill Keith Hill (rkeithhill) Oct 26, 2017

Copy link
Copy Markdown
Collaborator Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I can add that.

Sorry, something went wrong.

Uh oh!

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

@rkeithhill Keith Hill (rkeithhill) Oct 27, 2017

Copy link
Copy Markdown
Collaborator Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW, to be clear, this tweak affects only the help function on Linux/macOS/Windows as well as the man alias on Windows. That function pipes through a pager so we don't get rich objects out - just text. That is why I'm using -cmatch to look for certain words that indicate it is full help.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Keith Hill (rkeithhill) added 2 commits October 26, 2017 20:30
@rkeithhill
Display full help on non-Windows systems
0fd0ece 
Display full help on Windows systems where user has overriden pager with $env:PAGER.

Fix PowerShell#4962
@rkeithhill
Add tests for full view change to help function
1eb85f2
@rkeithhill
Keith Hill (rkeithhill) force-pushed the rkeithhill/full-help-output branch from c18eb53 to 1eb85f2 Compare October 27, 2017 05:07
@vors
sergei (vors) removed their request for review October 28, 2017 06:03
adityapatwardhan
Aditya Patwardhan (adityapatwardhan) requested changes Oct 30, 2017
View reviewed changes
Comment thread test/powershell/engine/Help/HelpSystem.Tests.ps1 Outdated
}
}

It "help should not return full view without -Full switch" -Skip:(!$IsWindows) {

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) Oct 30, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since you already have and after all the Skip should be done over there instead of repeating it in every It.

https://github.com/PowerShell/PowerShell/blob/master/docs/testing-guidelines/WritingPesterTests.md#skipping-tests-in-bulk

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread test/powershell/engine/Help/HelpSystem.Tests.ps1 Outdated
}
}

It "help should return full view without -Full switch" -Skip:(!$IsWindows) {

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) Oct 30, 2017

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@rkeithhill
Addess PR feedback on skip approach
be043d5
adityapatwardhan
Aditya Patwardhan (adityapatwardhan) approved these changes Oct 31, 2017
View reviewed changes

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@rkeithhill Keith Hill (rkeithhill) mentioned this pull request Nov 2, 2017
Before 6.0.0 ships can we make Get-Help -full the default? #4962
Closed
@rkeithhill
help function displays full help on all platforms
a1510a9 
As per PowerShell Committee discussion - PowerShell#4962 (comment)
@rkeithhill

Keith Hill (rkeithhill) commented Nov 4, 2017

Copy link
Copy Markdown
Collaborator Author

I think this is ready to go. The feedback from the @PowerShell/powershell-committee review was implemented in the last commit.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@adityapatwardhan Aditya Patwardhan (adityapatwardhan) changed the title Display full help on non-Windows systems Display full help with 'help' function Nov 6, 2017
@adityapatwardhan
Aditya Patwardhan (adityapatwardhan) merged commit c781959 into PowerShell:master Nov 6, 2017
@rkeithhill
Keith Hill (rkeithhill) deleted the rkeithhill/full-help-output branch May 29, 2019 15:21
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@rkeithhill @adityapatwardhan
Display full help with 'help' function (PowerShell#5195)
4113f1d 
Display full help with 'help' function
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@adityapatwardhan Aditya Patwardhan (adityapatwardhan) adityapatwardhan approved these changes
@BrucePay Bruce Payette (BrucePay) Awaiting requested review from BrucePay
@daxian-dbw Dongbo Wang (daxian-dbw) Awaiting requested review from daxian-dbw
@lzybkr Jason Shirk (lzybkr) Awaiting requested review from lzybkr

Uh oh!

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

Assignees

@adityapatwardhan Aditya Patwardhan (adityapatwardhan)

Labels

None yet

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

@rkeithhill @adityapatwardhan
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.