zsh-users
 help / color / mirror / code / Atom feed
From: Roman Perepelitsa <roman.perepelitsa@gmail.com>
To: Ray Andrews <rayandrews@eastlink.ca>
Cc: 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 21:08:53 +0100	[thread overview]
Message-ID: <CAN=4vMpcTGiKB7F+nyPnqo7Rdfw7Ja=_V+W+PeGA8UWjes2Daw@mail.gmail.com> (raw)
In-Reply-To: <395469e2-bcfe-467b-b749-85a284876b64@eastlink.ca>

On Fri, Jan 26, 2024 at 8:43 PM Ray Andrews <rayandrews@eastlink.ca> wrote:
>
> They are indispencible in the same way that the blueprints of a nuclear power station are indicpencible

Exactly, zsh documentation is a nuclear power station blueprints.
Transforming it into a basic physics tutorial would dilute its
effectiveness as a specialized blueprint. For foundational knowledge,
there are plenty of resources on the basics of physics.

On Fri, Jan 26, 2024 at 8:52 PM Steve Dondley <s@dondley.com> wrote:
>
> [...] 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.

I agree that your version would be better for someone unfamiliar with
this concept. But can you see that it might be less efficient for
someone who already understands it? And consider where to draw the
line with foundational explanations. Should we also explain what $HOME
is, what a directory means, or what 'consult' implies?

I understand it's frustrating to read something you're not yet
familiar with. This happens with any technical text. The documentation
works well for those at a certain knowledge level. You can get to that
level too, but you might need to learn from other sources first.

Roman.


  reply	other threads:[~2024-01-26 20:09 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
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 [this message]
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='CAN=4vMpcTGiKB7F+nyPnqo7Rdfw7Ja=_V+W+PeGA8UWjes2Daw@mail.gmail.com' \
    --to=roman.perepelitsa@gmail.com \
    --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).