Proposal: Remove section on "delight"#1236
Open
gordonsyme wants to merge 1 commit intonextfrom
Open
Conversation
The other parts of this CLI guide already cover the things that make a CLI pleasant to use: * stable output that's easily piped to Big Data Tools like awk/sed/cut etc. * good error messages * consistency in switches * consistent exit codes * easily accessible documentation * thoughtful use of colour in interactive contexts The examples given in the removed "Delight" section are examples of what not to do. * Don't use the CLI as a billboard for marketing/advertising. * Don't use wit in error messages. Something has gone wrong, the user has to work out what/why, and whimsical error messages diminish that fact.
gordonsyme
force-pushed
the
gordon/aoibhinn
branch
from
36d6987 to
77e00e3
Compare
calvis
approved these changes
Apr 27, 2026
calvis
left a comment
calvis
left a comment
There was a problem hiding this comment.
~ agree that these examples dont make sense for this context; wonder if we can recapture intent somewhere else? although it looks like delight is mentioned in the design philosophy already
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The other parts of this CLI guide already cover the things that make a
CLI pleasant to use:
etc.
The examples given in the removed "Delight" section are examples of what
not to do.
has to work out what/why, and whimsical error messages diminish
that fact.