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

Add Documentation for New PSReadLine Option ViClipboardMode #10325

Closed

Conversation

WestRyanK
Copy link

@WestRyanK WestRyanK commented Aug 2, 2023

PR Summary

This change adds documentation for the ViClipboardMode option being added to PSReadLine. Specifically, it updates the Get-PSReadLineOption.md and Set-PSReadLineOption.md for version 7.4 of PSReadLine. In these files it documents the usage of the command parameter -ViClipboardMode.

This is the associated PR:

When ViClipboardMode is set to SystemClipboard, copying and pasting will utilize the system's clipboard instead of a local clipboard while in Vi mode in PSReadLine. Using the system clipboard allows text to be copied and pasted between applications, terminal windows, and panes while in VI mode.

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributors guide.
  • Style: This PR adheres to the style guide.

@github-actions
Copy link

github-actions bot commented Aug 2, 2023

Expectations

Thanks for your submission! Here's a quick note to provide you with some context for what to expect from the docs team and the process now that you've submitted a PR. Even if you've contributed to this repo before, we strongly suggest reading this information; it might have changed since you last read it.

To see our process for reviewing PRs, please read our editor's checklist and process for managing pull requests in particular. Below is a brief, high-level summary of what to expect, but our contributor guide has expanded details.

The docs team begins to review your PR if you request them to or if your PR meets these conditions:

  • It is not a draft PR.
  • It does not have a WIP prefix in the title.
  • It passes validation and build steps.
  • It does not have any merge conflicts.
  • You have checked every box in the PR Checklist, indicating you have completed all required steps and marked your PR as Ready to Merge.

You can always request a review at any stage in your authoring process, the docs team is here to help! You do not need to submit a fully polished and finished draft; the docs team can help you get content ready for merge.

While reviewing your PR, the docs team may make suggestions, write comments, and ask questions. When all requirements are satisfied, the docs team marks your PR as Approved and merges it. Once your PR is merged, it is included the next time the documentation is published. For this project, the documentation is published daily at 3 p.m. Pacific Standard Time (PST).

@WestRyanK WestRyanK force-pushed the PSReadLine-ViSystemClipboard branch from 8a8482c to bb59fc7 Compare August 2, 2023 20:15
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 8a8482c:

✅ Validation status: passed

File Status Preview URL Details
reference/7.4/PSReadLine/Get-PSReadLineOption.md ✅Succeeded View (powershell-7.4)
reference/7.4/PSReadLine/Set-PSReadLineOption.md ✅Succeeded View (powershell-7.4)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit bb59fc7:

✅ Validation status: passed

File Status Preview URL Details
reference/7.4/PSReadLine/Get-PSReadLineOption.md ✅Succeeded View (powershell-7.4)
reference/7.4/PSReadLine/Set-PSReadLineOption.md ✅Succeeded View (powershell-7.4)

For more details, please refer to the build report.

For any questions, please:

@WestRyanK WestRyanK force-pushed the PSReadLine-ViSystemClipboard branch from bb59fc7 to 1b5f137 Compare August 2, 2023 20:23
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 1b5f137:

✅ Validation status: passed

File Status Preview URL Details
reference/7.4/PSReadLine/Get-PSReadLineOption.md ✅Succeeded View (powershell-7.4)
reference/7.4/PSReadLine/Set-PSReadLineOption.md ✅Succeeded View (powershell-7.4)

For more details, please refer to the build report.

For any questions, please:

@sdwheeler sdwheeler added hold-for-pr Waiting - for PR merge hold-for-release Waiting - for next release area-psreadline Area - PSReadline module labels Aug 2, 2023
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 5a54b78:

✅ Validation status: passed

File Status Preview URL Details
reference/7.4/PSReadLine/Get-PSReadLineOption.md ✅Succeeded View (powershell-7.4)
reference/7.4/PSReadLine/Set-PSReadLineOption.md ✅Succeeded View (powershell-7.4)

For more details, please refer to the build report.

For any questions, please:

@sdwheeler
Copy link
Contributor

The code PR is stalled and subject to change. Closing this docs PR for now. Can reopen if code PR updates.

@sdwheeler sdwheeler closed this Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-psreadline Area - PSReadline module hold-for-pr Waiting - for PR merge hold-for-release Waiting - for next release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants