disallow selecting shell prompt in code samples #7403
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this is a quick half-fix for command line examples, as discussed discussed in [1]. [1]: NixOS#7389 examples which look like this $ foo bar baz are confusing for Unix shell beginners, because it's hard to discern what is supposed to be entered into the actual command line when the convention of prefixing `$` is not known, as barely any real-world shell looks that way any more. this change prevents selecting the prompt part with the mouse in the HTML representation of the Nix manual. it does not prevent selecting the output part of the shell example. it also does not address that the copy button provided by mdBook takes the entire sample, including the prompts, into the clipboard.
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/tweag-nix-dev-update-41/23848/1 |
thufschmitt
approved these changes
Feb 10, 2023
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-02-10-nix-team-meeting-minutes-31/25438/1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this is a quick half-fix for command line examples, as discussed
discussed in 1.
examples which look like this
are confusing for Unix shell beginners, because it's hard to discern
what is supposed to be entered into the actual command line when the
convention of prefixing
$is not known, as barely any real-world shelllooks that way any more.
this change prevents selecting the prompt part with the mouse in the
HTML representation of the Nix manual.
it does not prevent selecting the output part of the shell example.
it also does not address that the copy button provided by mdBook takes
the entire sample, including the prompts, into the clipboard.