-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Closed
Labels
area-aboutArea - About_ topicsArea - About_ topicsarea-psreadlineArea - PSReadline moduleArea - PSReadline moduleissue-doc-bugIssue - error in documentationIssue - error in documentation
Description
Prerequisites
- Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
- Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Typo in
Get-Foo
cmdlet" instead of "Typo." - Verify Version: If there is a mismatch between documentation and the behavior on your system, ensure that the version you are using is the same as the documentation. Check this box if they match or the issue you are reporting is not version specific.
Links
https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_psconsolehostreadline
https://learn.microsoft.com/en-us/powershell/module/psreadline/psconsolehostreadline
Suggested Fix
Explains how to create a customize how PowerShell reads input at the console prompt.
I believe this should read, "Explains how to customize how PowerShell reads [...]".
The following example launches Notepad and gets input from a text File that the user creates:
Change to a lowercase "f".
EXAMPLES
REMARKS
Remove the unnecessary capitalization.
In addition, consider the following:
- Mention
PSReadLine
and link toPSConsoleHostReadLine
. - Link to the following Microsoft documentation on console modes such as "cooked".
- Wrap keyboard keys with
<kbd>
.
Metadata
Metadata
Assignees
Labels
area-aboutArea - About_ topicsArea - About_ topicsarea-psreadlineArea - PSReadline moduleArea - PSReadline moduleissue-doc-bugIssue - error in documentationIssue - error in documentation