Title: Extend Get-Help to support online documentation lookup for built-in .NET types · Issue #11338 · PowerShell/PowerShell · GitHub
Open Graph Title: Extend Get-Help to support online documentation lookup for built-in .NET types · Issue #11338 · PowerShell/PowerShell
X Title: Extend Get-Help to support online documentation lookup for built-in .NET types · Issue #11338 · PowerShell/PowerShell
Description: See also: #11339 #13550 Summary of the new feature/enhancement Get-Help supporting online lookup of documentation for built-in .NET types (those that ship with the framework / PowerShell) would be ... uh ... helpful, given: the close int...
Open Graph Description: See also: #11339 #13550 Summary of the new feature/enhancement Get-Help supporting online lookup of documentation for built-in .NET types (those that ship with the framework / PowerShell) would be ...
X Description: See also: #11339 #13550 Summary of the new feature/enhancement Get-Help supporting online lookup of documentation for built-in .NET types (those that ship with the framework / PowerShell) would be ...
Opengraph URL: https://github.com/PowerShell/PowerShell/issues/11338
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Extend Get-Help to support online documentation lookup for built-in .NET types","articleBody":"See also: \r\n* #11339\r\n* #13550\r\n\r\n# Summary of the new feature/enhancement\r\n\r\n`Get-Help` supporting online lookup of documentation for built-in .NET types (those that ship with the framework / PowerShell) would be ... uh ... helpful, given:\r\n\r\n* the close integration between PowerShell and .NET types in general\r\n* that there's no easy way to look up the types that PowerShell cmdlets outputs ([`MatchInfo`](https://docs.microsoft.com/en-US/dotnet/api/Microsoft.PowerShell.Commands.MatchInfo) comes to mind as a complex type whose documentation needs to be consulted to take full advantage of it - see also: https://github.com/MicrosoftDocs/PowerShell-Docs/issues/5221).\r\n\r\nBoth looking up by type name alone as well as a combination of type name and member name (to get help for a specific method, for instance) would be beneficial.\r\n\r\n# Proposed technical implementation details (optional)\r\n\r\nNote that since .NET documentation is only available online, conceptually `-Online` is implied when targeting .NET types.\r\n\r\nHere's how it _could_ work:\r\n\r\n```powershell\r\n# WISHFUL THINKING\r\n\r\n# Opens the documentation for the System.String.Split() method.\r\n# Note:\r\n# You can specify a type name ('string' in this example) as follows:\r\n# * Use a full type name, with the initial 'System.' component optionally omitted (e.g. 'Text.Encoding' for 'System.Text.Encoding'\r\n# * Use a PowerShell type accelerator such as 'xml' for 'System.Xml.XmlDocument'\r\n# Tab-completion can assist: You can type (part of) a the name of a type\r\n# (last component of the full name) and cycle through loaded types by that name.\r\n# E.g., typing `arrayli` tab-completes to 'System.Collections.ArrayList', which is the \r\n# Alternatively, *pipe* an instance of a string to the function (see next example).\r\nGet-Help -Type string -Member split\r\n\r\n# Opens the documentation for the [Microsoft.PowerShell.Commands.MatchInfo]\r\n# type, instances of which Select-String outputs.\r\n'foo' | Select-String o | Get-Help \r\n```\r\n\r\nNote:\r\n\r\n* Technically, `Get-Help` currently binds the `-Name` parameter by property value from the pipeline, but that appears to be broken anyway (and I've never seen it in the wild). Therefore binding pipeline objects to a new `-InputObject` parameter whose (distinct set of ) types are to be looked up should work.\r\n\r\n * Being able to do something like `'foo'.Split | Get-Help` would be great, but, unfortunately, the resulting `PSMethodInfo` instances contain no information about the enclosing _type_.\r\n\r\n* The lookup URL should include a `?view=netcore-\u003cmajor>.\u003cminor>` / `?view=netframework-\u003cmajor>.\u003cminor>` query string reflecting the .NET platform underlying the executing PowerShell engine.\r\n\r\n* For an implementation of this functionality as PowerShell function `Show-TypeHelp` (focused on .NET type lookup only), see [this Stack Overflow answer](https://stackoverflow.com/a/59324892/45375).\r\n\r\n\r\n","author":{"url":"https://github.com/mklement0","@type":"Person","name":"mklement0"},"datePublished":"2019-12-13T15:55:00Z","url":"https://github.com/PowerShell/PowerShell/issues/11338"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:384a3fc6-cc01-854f-deb2-ee3824bd3d60 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8ABC:99533:E13F61:1435766:6AFDB198 |
| html-safe-nonce | 1bfa2995658e32f2ab3ec29353e2160bcc32d6e25c41b788b6b3f3ba643bd64f |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QUJDOjk5NTMzOkUxM0Y2MToxNDM1NzY2OjZBRkRCMTk4IiwidmlzaXRvcl9pZCI6Ijc1MDU1NzgxODMzMjQ3MDkyNzIiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 4f5be45c2d10f0b601adc74a5165d26f80ada6b6ef3abbee5dc62a5a756d7f55 |
| hovercard-subject-tag | issue:537625230 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/PowerShell/PowerShell/11338/issue_layout |
| twitter:image | https://opengraph.githubassets.com/b7bb90544c55b2e46ec086fb14923d32cacd8ab95a3017da703ca964602e6a0e/PowerShell/PowerShell/issues/11338 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/b7bb90544c55b2e46ec086fb14923d32cacd8ab95a3017da703ca964602e6a0e/PowerShell/PowerShell/issues/11338 |
| og:image:alt | See also: #11339 #13550 Summary of the new feature/enhancement Get-Help supporting online lookup of documentation for built-in .NET types (those that ship with the framework / PowerShell) would be ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | mklement0 |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3c532f4d069d6fbe9b1837450343d1b9e0619a7d5c4ba0b3b64fd8e0bae67c7e |
| turbo-cache-control | no-preview |
| go-import | github.com/PowerShell/PowerShell git https://github.com/PowerShell/PowerShell.git |
| octolytics-dimension-user_id | 11524380 |
| octolytics-dimension-user_login | PowerShell |
| octolytics-dimension-repository_id | 49609581 |
| octolytics-dimension-repository_nwo | PowerShell/PowerShell |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 49609581 |
| octolytics-dimension-repository_network_root_nwo | PowerShell/PowerShell |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 5396ad00d1c6d19097aee7fc4d00a2eb03432c8f |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width