Re: Can't tell the difference in operation between PATH_SCRIPT and NO_PATH_SCRIPT

[Steve Dondley <s@xxxxxxxxxxx>]

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@xxxxxxxxx> wrote:
> 
> On Fri, Jan 26, 2024 at 8:17 PM Steve Dondley <s@xxxxxxxxxxx> 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.