Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get-Help -Online fails for Commands in LocalAccounts module - Preview 6 #11268

Closed
doctordns opened this issue Dec 5, 2019 · 12 comments
Closed
Labels
Issue-Question ideally support can be provided via other mechanisms, but sometimes folks do open an issue to get a Resolution-Answered The question is answered.

Comments

@doctordns
Copy link
Contributor

If you use the command:

Get-Help -Online <cmdletname>

You get the help text at Docs.Microsoft.com. For example, if I Get-Help for Get-Help, I am redirected to
https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/get-help?view=powershell-7 (i.e. the culture aware help location! for that cmdlet).

However for the cmdlets in the Microsoft.PowerShell.LocalAccounts module, attempting to Get-Help -online results in being directed to https://www.microsoft.com/en-gb/?ref=go1.

It appears that the necessary help files are not in Docs.Microsoft.Com's help system.

Steps to reproduce

Get-Help -Online -Name 'Get-Help'

Expected behaviour

I expected to be sent to a PowerShell 7 related help page.

Actual behaviour

Sent to https://www.microsoft.com/en-gb/?ref=go

Environment data

PS C:\foo> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      7.0.0-preview.6
PSEdition                      Core
GitCommitId                    7.0.0-preview.6
OS                             Microsoft Windows 10.0.19033
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0, 5.0, 5.1.10032.0, 6.0.0, 6.1.0, 6.2.0, 7.0.0-preview.6}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

NB.: I tested this in 7.0.0-daily.20191204 and it fails in the same way. FWIW.

@doctordns doctordns added the Issue-Question ideally support can be provided via other mechanisms, but sometimes folks do open an issue to get a label Dec 5, 2019
@iSazonov
Copy link
Collaborator

iSazonov commented Dec 5, 2019

LocalAccounts module was removed from PowerShell 6/7 so it is expected that Get-Help for cmdlets from the module doesn't work.

@iSazonov iSazonov added the Resolution-Answered The question is answered. label Dec 5, 2019
@doctordns
Copy link
Contributor Author

Yes and no.
I can (and do) import this module and use the commands natively. To the user, it is a module of commands I can access from PowerShell 7. It appears to be being loaded using the new compatibility logic and acts like a native module.

From a help perspective, this module does not seem to exist (for PWSH7) yet its commands do certainly exist. I would argue that the user is expecting to be able to Get-Help on a directly available command. Even though you may not ship it, it is a module directly accessible from what you do ship thus at least point to the 5.1 help!

@iSazonov
Copy link
Collaborator

iSazonov commented Dec 5, 2019

The compatibility system is intended only to facilitate the transition period to PowerShell 7.
I think it’s not worth the effort, especially since Help System in PowerShell Core will be replaced with new version soon.
/cc @anmenaga

@doctordns
Copy link
Contributor Author

So why can't the relevant cmdlets be coded so as to point to the 5.1 content to give a more consistent user experience?

@vexx32
Copy link
Collaborator

vexx32 commented Dec 5, 2019

@doctordns typically the online help link is defined by the module itself; I wouldn't think that PS7 would make a difference here, you should be seeing the same behaviour running the Get-Help -Online command from 5.1 for these commands unless there's something I'm missing.

The module itself would need to be updated either way. @iSazonov do you know if that module is in this repo, or if it's managed in a separate repo?

@iSazonov
Copy link
Collaborator

iSazonov commented Dec 5, 2019

The cmdlets present only in remote session and Help System see only proxies. If Help System don't see HelpUrl in the proxies I think it’s not worth the effort to enhance it,

do you know if that module is in this repo, or if it's managed in a separate repo?

The module was removed from the repo for compliance reasons. I started a work on new module #9926 and related RFC but there is still a small progress.

@msftbot
Copy link

msftbot bot commented Dec 7, 2019

This issue has been marked as answered and has not had any activity for 1 day. It has been closed for housekeeping purposes.

@msftbot msftbot bot closed this as completed Dec 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue-Question ideally support can be provided via other mechanisms, but sometimes folks do open an issue to get a Resolution-Answered The question is answered.
Projects
None yet
Development

No branches or pull requests

4 participants
@doctordns @iSazonov @vexx32 and others