zsh-users
 help / color / mirror / code / Atom feed
From: Ray Andrews <rayandrews@eastlink.ca>
To: 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 12:06:52 -0800	[thread overview]
Message-ID: <76eab1d7-be5b-4786-9c23-c9d63a3ba27b@eastlink.ca> (raw)
In-Reply-To: <80CBCA13-4B81-4522-8A98-4CE14B524CDA@dondley.com>

[-- Attachment #1: Type: text/plain, Size: 1986 bytes --]


On 2024-01-26 11:52, Steve Dondley wrote:
> 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.

You and I have essentially identical ideas about how it should read.  
Even if the manual is to be a manual, not a 'zsh for dummies', the 
language could be much more helpful.  But it's as long as the Bible, and 
who's going to spend a year giving it a workover?

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.
Yes, it does, and so it must.
>> 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.

Yup, so there's the dilemma.  But even then, as Steve's little example 
above shows, within the culture of a manual (not a help resource) things 
could be better.  If it were up to me I'd paste Steve's little edit 
above into the manual -- subject to a close look by the experts of 
course.  The devs have admitted a few changes, but much more could be 
done IMHO.  Things don't have to be terse and obscure.


[-- Attachment #2: Type: text/html, Size: 3062 bytes --]

  reply	other threads:[~2024-01-26 20:07 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
2024-01-26 20:06                                 ` Ray Andrews [this message]
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=76eab1d7-be5b-4786-9c23-c9d63a3ba27b@eastlink.ca \
    --to=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).