declarative shells tutorial: more generic example commands #901
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
henrik-ch
approved these changes
Feb 8, 2024
henrik-ch
approved these changes
Feb 9, 2024
There was a problem hiding this comment.
👍 This works as expected as far as I can see, and I consider it an improvement as it's simpler and requires less unix cli knowledge. (Beginners may not know what is part of nix and not or struggle with the overhead of learning about man pages at the same time as they learn nix)
too much character noise distracts from the principle
fricklerhandwerk
force-pushed
the
better-shellhook
branch
from
e7b414b
to
92319ec
Compare
|
@fricklerhandwerk thank you, this is so much clearer for newcomers! |
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.
fixes #892
@aynsof thanks for reporting!
@nixos/documentation-team what do you think? We discussed a long time ago #498 (comment) to use developer-oriented tools in the examples, but this seems to keep failing due to ever so slightly elevated requirements for them to actually work.
I'm now inclined to keep examples deliberately toy-like to avoid obscuring the actual thing we want to teach.
Admittedly, this particular change adds lots of character noise, but I couldn't come up with something more elegant (brief but powerful) in the short amount of time I gave it.
Maybe someone has a better suggestion?