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.

Sign up for GitHub

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

Jump to bottom

doc: Improve code listings #98503

Merged
merged 2 commits into from Sep 24, 2020
Merged

doc: Improve code listings #98503

merged 2 commits into from Sep 24, 2020

Conversation

jtojnar
Copy link
Contributor

@jtojnar jtojnar commented Sep 22, 2020

Motivation for this change

I can't stand it when I double click a command line to select it and the prompt is selected too so I need to manually deselect it before copying, or delete it after pasting.

Since the last time I fixed this, there appeared some new unmarked prompts so I marked them.
I also added few replaceables and removed extraneous indentation where I noticed it.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/share/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@jtojnar jtojnar requested a review from nbp as a code owner September 22, 2020 22:45
@jtojnar
doc: Improve code listings
e1af376 
By adding prompts and removing unnecessary indentation.
@jtojnar
nixos/doc: Improve code listings
e6ce041 
By adding prompts and replaceables and removing unnecessary indentation.
@jtojnar jtojnar merged commit 6d518dd into NixOS:master Sep 24, 2020
@jtojnar jtojnar deleted the doc-prompts branch September 24, 2020 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nbp nbp Awaiting requested review from nbp

Assignees
No one assigned
Labels
6.topic: erlang 6.topic: nixos 6.topic: qt/kde 6.topic: ruby 6.topic: TeX Issues regarding texlive and TeX in general 8.has: documentation 8.has: module (update) 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 10.rebuild-linux: 1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@jtojnar