zsh-users
 help / color / mirror / code / Atom feed
From: Daniel Shahaf <d.s@daniel.shahaf.name>
To: Ray Andrews <rayandrews@eastlink.ca>
Cc: zsh-users@zsh.org
Subject: Re: Most minimal configuration challenge
Date: Sun, 4 Sep 2022 07:13:00 +0000	[thread overview]
Message-ID: <20220904071300.GQ5920@tarpaulin.shahaf.local2> (raw)
In-Reply-To: <789b8b92-ef70-940f-b24a-4edb27a59bd7@eastlink.ca>

Ray Andrews wrote on Fri, Sep 02, 2022 at 07:26:54 -0700:
> On 2022-09-02 03:36, Daniel Shahaf wrote:
> 
> Ironically this sentence would be the perfect start to some doc about
> zstyle that was actually helpful:
> 
> > There's no easy way to explain zstyle in a sentence since it has so many
> > moving parts (keys, values, contexts, context patterns).
> 
> ... start off by letting the reader know that zstyle is [complex]

Personally, I find that sentence doesn't actually convey any (objective)
information about what zstyle is or does, so it'd be among the first
things I'd cut.

You are of course welcome to grab a pen or a keyboard and write "Ray's
Introduction to zstyle" (or whatever you might call it) and start it
like that.  If you use a nice markdown editor and put it on github…

> > 
> > 3. Readers (including lurkers) would get a fishing rod rather than a fish.
> > 
> But sometimes what you want is a fish.  That's the perfect analogy tho. 
> Sometimes I
> want a fishing rod, sometimes I want a fish.  When it comes to
> documentation, they
> are very different things.

Perhaps what you have in mind here is the difference between a tutorial
or user manual on the one hand, and a reference manual on the other
hand.

zsh's manual is of the second kind.


  reply	other threads:[~2022-09-04  7:23 UTC|newest]

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-08-27  4:30 Felipe Contreras
2022-08-27 16:10 ` Daniel Shahaf
2022-08-27 19:32   ` Vincent Bernat
2022-08-27 20:04     ` Lawrence Velázquez
2022-08-27 23:53       ` Ray Andrews
2022-08-28  7:53         ` zzapper
2022-08-28 10:30         ` Daniel Shahaf
2022-08-28 13:59           ` Ray Andrews
2022-08-28 18:29             ` Daniel Shahaf
2022-08-31  9:28               ` Vincent Lefevre
2022-08-31 14:17                 ` Ray Andrews
2022-09-01 21:52                   ` Felipe Contreras
2022-09-02  1:41                     ` Lawrence Velázquez
2022-09-02  1:26                   ` Lawrence Velázquez
2022-09-02  1:49                     ` Felipe Contreras
2022-09-02  5:40                       ` Lawrence Velázquez
2022-09-02  7:38                         ` Felipe Contreras
2022-09-02 10:36                       ` Daniel Shahaf
2022-09-02 14:26                         ` Ray Andrews
2022-09-04  7:13                           ` Daniel Shahaf [this message]
2022-09-04 16:30                             ` Ray Andrews
2022-09-02 10:39                       ` [PATCH] zstyle: Correct and expand docs (was: Re: Most minimal configuration challenge) Daniel Shahaf
2022-09-02 15:05                         ` Bart Schaefer
2022-09-04  6:51                           ` Daniel Shahaf
2022-09-02 13:55                       ` Most minimal configuration challenge Ray Andrews
2022-09-04  7:21                         ` Daniel Shahaf
2022-09-04 16:34                           ` Ray Andrews
2022-09-02 13:32                     ` Ray Andrews
2022-09-04  7:28                       ` Daniel Shahaf
2022-09-02  9:53                   ` Daniel Shahaf
2022-09-02  9:26                 ` Daniel Shahaf
2022-09-02 14:44                   ` Vincent Lefevre
2022-09-04  6:42                     ` Daniel Shahaf
2022-09-05  9:47                       ` Vincent Lefevre
2022-09-12  8:59                         ` Daniel Shahaf
2022-08-28 18:58             ` Bart Schaefer
2022-08-28 19:23               ` Felipe Contreras
2022-08-28 19:35               ` Ray Andrews
2022-08-28 18:57   ` Felipe Contreras
2022-09-02  1:36 ` Vincent Lefevre

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220904071300.GQ5920@tarpaulin.shahaf.local2 \
    --to=d.s@daniel.shahaf.name \
    --cc=rayandrews@eastlink.ca \
    --cc=zsh-users@zsh.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.vuxu.org/mirror/zsh/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).