From: Steve Dondley <s@dondley.com>
To: Roman Perepelitsa <roman.perepelitsa@gmail.com>
Cc: Ray Andrews <rayandrews@eastlink.ca>, zsh-users@zsh.org
Subject: Re: Can't tell the difference in operation between PATH_SCRIPT and NO_PATH_SCRIPT
Date: Fri, 26 Jan 2024 14:52:48 -0500 [thread overview]
Message-ID: <80CBCA13-4B81-4522-8A98-4CE14B524CDA@dondley.com> (raw)
In-Reply-To: <CAN=4vMpYypY2LjrLm74FFMSG05Ekv8nxTCUOfVSp_h=2YCs0sw@mail.gmail.com>
Right. I’m just suggesting the documentation could put in more effort giving a nod and helping hand to those who don’t have a lot of experience with shells.
For example, instead of just dropping ZDOTDIR on my head like I already knew what it was, it could instead say:
On most systems,, a user’s zsh configuration files are kept in their $HOME directory by default. If you wish to store these modules in a different location, this can be modified by setting the value of the ZDOTDIR parameter to a directory path of your choosing. For example, if you wish your user to follow the XDG specification, you might set the value to $HOME/.config/zsh. Typically, this value is set in the /some/config/file configuration file but consult your OS’s manual for details.
This is a much gentler way of introducing this variable to me.
> On Jan 26, 2024, at 2:38 PM, Roman Perepelitsa <roman.perepelitsa@gmail.com> wrote:
>
> On Fri, Jan 26, 2024 at 8:17 PM Steve Dondley <s@dondley.com> wrote:
>>
>> I see ZDOTDIR listed in the “Parameters” chapter. I have no idea
>> what a “Parameter” is.
>
> Consider a cookie recipe that starts with "Cream the butter and sugar
> until light and fluffy." It assumes a basic understanding of baking
> techniques. Similarly, the zsh documentation, with terms like
> "Parameter", presupposes basic shell knowledge. It's geared towards
> those who have this baseline, much like the recipe book is for those
> with rudimentary cooking skills.
>
>> But my main point is that it feels like the documentation makes the
>> assumption you know how a typical shell works and that you are
>> familiar with the many common features between the different kinds
>> of shells.
>
> Your observation is correct. All documentation, including zsh's, must
> assume some level of prior knowledge. When our understanding doesn't
> meet this level, it can be challenging and frustrating, but we can
> bridge this gap through other resources. On the other hand, if the
> documentation were too basic, covering familiar ground, it would be
> inefficient for advanced users, leaving them to sift through redundant
> information.
>
> Roman.
next prev parent reply other threads:[~2024-01-26 19:54 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-26 2:00 Steve Dondley
2024-01-26 3:05 ` Lawrence Velázquez
2024-01-26 3:21 ` Steve Dondley
2024-01-26 3:30 ` Steve Dondley
2024-01-26 3:45 ` Lawrence Velázquez
2024-01-26 4:17 ` Steve Dondley
2024-01-26 4:58 ` Lawrence Velázquez
2024-01-26 5:20 ` Steve Dondley
2024-01-26 5:52 ` Bart Schaefer
2024-01-26 6:35 ` Lawrence Velázquez
2024-01-26 15:49 ` Steve Dondley
2024-01-26 16:07 ` Mark J. Reed
2024-01-26 16:41 ` Mark J. Reed
2024-01-26 17:21 ` Steve Dondley
2024-01-26 18:28 ` Ray Andrews
2024-01-26 18:38 ` Roman Perepelitsa
2024-01-26 19:17 ` Steve Dondley
2024-01-26 19:38 ` Roman Perepelitsa
2024-01-26 19:52 ` Steve Dondley [this message]
2024-01-26 20:06 ` Ray Andrews
2024-01-26 20:16 ` Lawrence Velázquez
2024-01-26 19:54 ` Ray Andrews
2024-01-26 20:05 ` Steve Dondley
2024-01-26 20:43 ` Steve Dondley
2024-01-27 2:34 ` .m0rph
2024-01-26 19:42 ` Ray Andrews
2024-01-26 20:08 ` Roman Perepelitsa
2024-01-26 20:21 ` Steve Dondley
2024-01-26 20:40 ` Ray Andrews
2024-01-26 6:25 ` Lawrence Velázquez
2024-01-26 6:42 ` Lawrence Velázquez
2024-01-26 15:27 ` Steve Dondley
2024-01-26 4:35 ` Lawrence Velázquez
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=80CBCA13-4B81-4522-8A98-4CE14B524CDA@dondley.com \
--to=s@dondley.com \
--cc=rayandrews@eastlink.ca \
--cc=roman.perepelitsa@gmail.com \
--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).