Title: Extend Get-Help to support focused lookup of documentation for PowerShell operators · Issue #11339 · PowerShell/PowerShell · GitHub
Open Graph Title: Extend Get-Help to support focused lookup of documentation for PowerShell operators · Issue #11339 · PowerShell/PowerShell
X Title: Extend Get-Help to support focused lookup of documentation for PowerShell operators · Issue #11339 · PowerShell/PowerShell
Description: See also: #11338 #13550 Summary of the new feature/enhancement PowerShell has a wealth of operators, many of them with sophisticated functionality, even in the case of operators familiar from other languages (e.g., * offering not just nu...
Open Graph Description: See also: #11338 #13550 Summary of the new feature/enhancement PowerShell has a wealth of operators, many of them with sophisticated functionality, even in the case of operators familiar from other...
X Description: See also: #11338 #13550 Summary of the new feature/enhancement PowerShell has a wealth of operators, many of them with sophisticated functionality, even in the case of operators familiar from other...
Opengraph URL: https://github.com/PowerShell/PowerShell/issues/11339
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Extend Get-Help to support focused lookup of documentation for PowerShell operators","articleBody":"See also: \r\n* #11338\r\n* #13550\r\n\r\n# Summary of the new feature/enhancement\r\n\r\nPowerShell has a wealth of operators, many of them with sophisticated functionality, even in the case of operators familiar from other languages (e.g., `*` offering not just numeric multiplication, but also string replications).\r\n\r\nTo take full advantage of them, consulting the documentation is necessary, yet this documentation is currently hard to discover.\r\n\r\n`Get-Help` should support an easy way to offer _focused_ lookup of the documentation for any given operator, via the operator symbols themselves - ideally by showing / navigation to just the relevant portion of the enclosing `about_*Operators*` page or similar.\r\n\r\n# Proposed technical implementation details (optional)\r\n\r\nHere's how it _could_ work:\r\n\r\n```powershell\r\n# WISHFUL THINKING\r\n\r\n# Lists the names of all about_*Operators* topics.\r\nGet-Help -Category Operator\r\n\r\n# Opens the help topic (section) for the -replace operator.\r\n# Allow omitting the initial '-'; if you do specify it, quote the entire argument.\r\nGet-Help -Category Operator -Name 'replace'\r\n\r\n# For simplicity, if the (positional) -Name argument is unambiguously an operator symbol,\r\n# do not require -Category Operator\r\n# Ignore whitespace in all arguments, so that, e.g., '@( )` works in addition to '@()'\r\nGet-Help '@()' # -Category Operator implied\r\nGet-Help '-replace'\r\nGet-Help '%'\r\nGet-Help '>'\r\nGet-Help '--%' # not technically an operator, but we should support it too\r\n\r\n# Quotes aren't technically operators, but we should support them too:\r\n# All of these could open the about_Quoting_Rules topic.\r\nGet-Help '\"' # or: '\"\"'\r\nGet-Help \"'\" # or: \"''\"\r\nGet-Help \"@'\" # or: \"@''@\"\r\nGet-Help '@\"' # or: '@\"\"@'\r\n\r\n# Ambiguous symbols\r\nGet-Help '[]' # either default to indexer over casts / type constraints, or list both to force disambiguation\r\nGet-Help '[0]' # interpret as indexer; also: Get-Help '[\"foo\"]' \r\nGet-Help '[int]' # interpret as cast / type constraint; any non-numeric unquoted name should work\r\n\r\nGet-Help '.' # default to member-access over dot-sourcing; print hint for how to look up dot-sourcing\r\nGet-Help '. ' # dot-sourcing (trailing space disambiguates)\r\n\r\nGet-Help '&' # default to call operator over background operator, print hint for how to look up the background operator\r\nGet-Help ' &' # background operator (leading space disambiguates)\r\n\r\nGet-Help '@' # default to splatting, but print hint for how to look up @() and @'...'@\r\n```\r\n\r\nIt would also be helpful to be able to output a concise table of operators, along the following lines:\r\n\r\n```powershell\r\n# Not sure what the best syntax is here; maybe include it in about_Operators with links to\r\n# the operator-specific descriptions.\r\n# Note the 'LookupName' column which shows how to resolve ambiguities.\r\nPS> Get-Help about_OperatorTable\r\n```\r\n```none\r\nName FriendlyName Category LookupName\r\n---- ------------ -------- ----------\r\n--% stop-parsing symbol ArgumentPassing\r\n@ splatting ArgumentPassing\r\n- subtraction / sign inversion Arithmetic\r\n* multiplication / string replication Arithmetic\r\n...\r\n+ addition / string concatenation Arithmetic\r\n, array constructor Array\r\n.. range (numbers/characters) Array\r\n-- decrement Assignment\r\n-= compound assignment Assignment\r\n...\r\n-band bitwise AND Bitwise\r\n-bNot bitwise complement Bitwise\r\n...\r\n?: ternary conditional Conditional\r\n?? null-coalescing Conditional\r\n-contains collection contains RHS Containment\r\n-in LHS contained in RHS Containment\r\n-notContains collection doesn't contain RHS Containment\r\n-notIn LHS not contained in collection Containment\r\n-eq equality Equality\r\n-ge greater-than-or-equal Equality\r\n# ...\r\n@() array-subexpression Evaluation\r\n$() subexpression Evaluation\r\n. (dot-)source Execution '. '\r\n& background Execution ' &'\r\n& call (execute) Execution\r\n-and logical AND Logical\r\n...\r\n```\r\n \r\n\r\nNote:\r\n\r\n* For _offline_ use in the _console_, the current help topics aren't structured enough to show the relevant topic _excerpts_ focused just on the specified operator.\r\n * However, for _online_, _browser-based_ lookups this already works via HTML anchors; e.g., `-replace` is described specifically at https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_Comparison_Operators?view=powershell-7#replacement-operator\r\n\r\n * Some operators don't have individual sections even online, such as the arithmetic operators, but the enclosing topic is then usually short enough to find the information of interest easily.\r\n\r\n* For an implementation of this functionality as PowerShell function `Show-OperatorHelp` (focused on operators only and only with _online_ lookup), see [this Stack Overflow answer](https://stackoverflow.com/a/59324892/45375).\r\n\r\n","author":{"url":"https://github.com/mklement0","@type":"Person","name":"mklement0"},"datePublished":"2019-12-13T16:57:54Z","url":"https://github.com/PowerShell/PowerShell/issues/11339"}
| 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:8609e488-a8bd-ad26-aac1-70a6149dd96e |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9A70:396ACD:CCBF50:125A82B:6AFDAB79 |
| html-safe-nonce | 0b3b2318f7e8aeb5da4d1558148374a6d59274bfb49a660e80850681b8f521fa |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5QTcwOjM5NkFDRDpDQ0JGNTA6MTI1QTgyQjo2QUZEQUI3OSIsInZpc2l0b3JfaWQiOiIzMjY5MTY5OTQ0NjEyMTU0MjMzIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | db61d32a69b9c007e59633451588e01ce2c777250a2c3400b8bb07979ff1a512 |
| hovercard-subject-tag | issue:537658519 |
| 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/11339/issue_layout |
| twitter:image | https://opengraph.githubassets.com/a7486a04359860ba787e39f458d748af97b95cdce8885be07ae9735b03a7a7b9/PowerShell/PowerShell/issues/11339 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/a7486a04359860ba787e39f458d748af97b95cdce8885be07ae9735b03a7a7b9/PowerShell/PowerShell/issues/11339 |
| og:image:alt | See also: #11338 #13550 Summary of the new feature/enhancement PowerShell has a wealth of operators, many of them with sophisticated functionality, even in the case of operators familiar from other... |
| 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 | bc86424ef34a73b386237872800e922d149d65ba907f63d6f150a2dcb8433bea |
| 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 | 0ddf53eb35c87f1f8df13dbf75c3bdadbfc6e969 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width