From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=-3.2 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_EF,HEADER_FROM_DIFFERENT_DOMAINS,HTML_MESSAGE, MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.4 Received: from zero.zsh.org (zero.zsh.org [IPv6:2a02:898:31:0:48:4558:7a:7368]) by inbox.vuxu.org (Postfix) with ESMTP id 6E3A321CD2 for ; Fri, 26 Jan 2024 21:07:33 +0100 (CET) ARC-Seal: i=1; cv=none; a=rsa-sha256; d=zsh.org; s=rsa-20210803; t=1706299653; b=gZhGiftlNI5klK+zEDKbCyY7f3KVbNhNh66h5gUwqOhj60nSibA34ugGFt7/KMkfa0KUA822C2 /5YYAk9IaHh3iw2o2w1VVcwv2yzzIjYSxooBmGIAfgdp+uG3Bv7ScezxfUv10eR6diLZi+0kWY vUg4pniYkD3xBlWQonfb48Zm5iG2ZW07o7d9zFkNFpv3/gBOQVEGxN0rQynJ2bzVjAGPWzyYj9 G+PBKPiTdIOe55XPXq7WKXGQFgSQ7oM6CBsE1n9GE0jWF+4sld9u12zR64+eQtQRCZb3oIkycb wHpzz5WzHmYL+WlyBCRMT88Lqa4HqGRv6LOZhkHZYYmHmw==; ARC-Authentication-Results: i=1; zsh.org; iprev=pass (mta02.eastlink.ca) smtp.remote-ip=24.224.136.13; dmarc=none header.from=eastlink.ca; arc=none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed; d=zsh.org; s=rsa-20210803; t=1706299653; bh=Gtw9FbE7ZsLTeOKxlM2bJc5eWUhW5oPuTmWQm1ZhBIQ=; h=List-Archive:List-Owner:List-Post:List-Unsubscribe:List-Subscribe:List-Help: List-Id:Sender:In-Reply-To:From:References:To:Subject:MIME-Version:Date: Message-ID:Content-Type:DKIM-Signature; b=CAu9HKgVpcNxvqLT4DepkcM0Qyeo4SzVO358pbSLcTZyZN3iUO5Wi+9XE2g2kM2uj4hSzqR4XO wRenvbD7OkwuH4Hmb3vM5GvOeK/NiY2UHB+NnxzD6c50Geu0ngAb/e4ukrJiS14OxCD6m3Nq1j Xwarx3qnpJVfSuSCSh7ugvFjSKBIFiH7W1DlCEdOejmWioVV5rFQFWUUXpPJ36EQZQqF8ygG5w 6cNpkuUTfXM5mEvXQxVlHxJbVQrapKfqSco/STI3eiZzqxSW7x/6SaDUojb/6HUbIXc+pbkJ8O dv2ndFgkZ23UdEUaR/KCOtTVZtsM13LEciVGs+zYDvjobg==; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=zsh.org; s=rsa-20210803; h=List-Archive:List-Owner:List-Post:List-Unsubscribe: List-Subscribe:List-Help:List-Id:Sender:In-reply-to:From:References:To: Subject:MIME-version:Date:Message-id:Content-type:Reply-To:Cc: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID; bh=xm+pnH+W9QVEikfnavlfuyMSLb/VM+D9RrONW858OyU=; b=qGeoTUuUB2lZG7n+t4FIagqlsp efmsvsHY6e0/Y9i0S61v9Jv2fyOJqEUgkAIicOjG/g2XnBMiF3xFOLIlzhFMlcD0rulbiR/+Wf5X/ NWDP0biVx9iAGAShL+7ZLqFPzA6Mz1gThDYGbn4plt1+8PYy23EYgPv2/PqpjXCf/BPa07LMhjZYk 8Abvdc1lcYdcpyKdFHQtG9IlpHZdcdKsUelOxucZxxxOE9iSguTI11sURwH3kLjRkiXJrfZfcXGKo N6QulLNfrkD8m73prWJMcydzyKMSlTfuevq6lzBXaVYGG3bZHqJQKzpnNVUIzPn4JYzxvhL48D/+m 3M4Xm64w==; Received: by zero.zsh.org with local id 1rTSU9-000Kh1-6l; Fri, 26 Jan 2024 20:07:33 +0000 Authentication-Results: zsh.org; iprev=pass (mta02.eastlink.ca) smtp.remote-ip=24.224.136.13; dmarc=none header.from=eastlink.ca; arc=none Received: from mta02.eastlink.ca ([24.224.136.13]:54969) by zero.zsh.org with esmtps (TLS1.3:TLS_AES_128_GCM_SHA256:128) id 1rTSTW-000JmM-E6; Fri, 26 Jan 2024 20:06:54 +0000 Received: from csp02.eastlink.ca ([71.7.199.167]) by mta02.eastlink.ca ([24.224.136.13]) with ESMTPS id <0S7V0JMHAX0BJRD1@mta02.eastlink.ca> for zsh-users@zsh.org; Fri, 26 Jan 2024 16:06:53 -0400 (AST) Received: from [192.168.0.11] (host-24-207-19-13.public.eastlink.ca [24.207.19.13]) by csp02.eastlink.ca ([71.7.199.167]) with ESMTPSA id TSTUrtJn71sDHTSTVrcLwT (version=TLSv1_2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256); Fri, 26 Jan 2024 16:06:53 -0400 X-Authority-Analysis: v=2.4 cv=SpQz6+O0 c=1 sm=1 tr=0 ts=65b410dd a=e7T7DzMKK1R988ZCg0wLyw==:117 a=e7T7DzMKK1R988ZCg0wLyw==:17 a=r77TgQKjGQsHNAKrUKIA:9 a=4czCtCrj2yqdtXlsn8gA:9 a=QEXdDO2ut3YA:10 a=XGQ5bAkIAAAA:8 a=pKiffMxWMFyqBEIqBekA:9 a=V0-VqlxTqeBi3Y8Q:21 a=_W_S_7VecoQA:10 a=4eFx6D7NvP7b3IdYF4p0:22 X-Vade-Cause: gggruggvucftvghtrhhoucdtuddrgedvkedrvdeljedgudefudcutefuodetggdotefrodftvfcurfhrohhfihhlvgemucfgtefuvffnkffpmfdpqfgfvfenuceurghilhhouhhtmecufedttdenucenucfjughrpegtkfffgggfuffvfhfhjgesrgdtreertddvjeenucfhrhhomheptfgrhicutehnughrvgifshcuoehrrgihrghnughrvgifshesvggrshhtlhhinhhkrdgtrgeqnecuggftrfgrthhtvghrnhephfettefhveeguedvleeggfdvvedufeeuudffvdfgledvvdfgtdeigeeuueelieefnecukfhppedvgedrvddtjedrudelrddufeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepihhnvghtpedvgedrvddtjedrudelrddufedphhgvlhhopegludelvddrudeikedrtddruddungdpmhgrihhlfhhrohhmpehrrgihrghnughrvgifshesvggrshhtlhhinhhkrdgtrgdpnhgspghrtghpthhtohepvddprhgtphhtthhopeerredprhgtphhtthhopeiishhhqdhushgvrhhsseiishhhrdhorhhgpdhgvghtqdgkihhprfgrshhsfigupehtrhhuvg X-Vade-Score: 0 X-Vade-State: 0 X-EL-AUTH: rayandrews@eastlink.ca Content-type: multipart/alternative; boundary="------------zC3zoBxlIUgpBaZplj6hnQxD" Message-id: <76eab1d7-be5b-4786-9c23-c9d63a3ba27b@eastlink.ca> Date: Fri, 26 Jan 2024 12:06:52 -0800 MIME-version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: Can't tell the difference in operation between PATH_SCRIPT and NO_PATH_SCRIPT Content-language: en-US To: zsh-users@zsh.org References: <73E4333B-C282-4A58-837C-A50F73E13289@dondley.com> <680FA5D3-E8FD-49F2-9AE3-C169A6D9DA9E@dondley.com> <4a1df20e-70c4-41ed-b370-4fbbae0619b9@app.fastmail.com> <3DC872AC-5B19-468D-85D5-5D3A501EF7E9@dondley.com> <2CF29A22-6721-4275-8E92-7FF61CE4CDCB@dondley.com> <316F625D-EC13-43C5-808F-B78DD09E906C@dondley.com> <80CBCA13-4B81-4522-8A98-4CE14B524CDA@dondley.com> From: Ray Andrews In-reply-to: <80CBCA13-4B81-4522-8A98-4CE14B524CDA@dondley.com> X-Seq: 29590 Archived-At: X-Loop: zsh-users@zsh.org Errors-To: zsh-users-owner@zsh.org Precedence: list Precedence: bulk Sender: zsh-users-request@zsh.org X-no-archive: yes List-Id: List-Help: , List-Subscribe: , List-Unsubscribe: , List-Post: List-Owner: List-Archive: This is a multi-part message in MIME format. --------------zC3zoBxlIUgpBaZplj6hnQxD Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit 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. --------------zC3zoBxlIUgpBaZplj6hnQxD Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: 8bit


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.


--------------zC3zoBxlIUgpBaZplj6hnQxD--