From: Ray Andrews <rayandrews@eastlink.ca>
To: zsh-users@zsh.org
Subject: Re: Tagged parameters
Date: Tue, 15 Aug 2023 08:16:35 -0700 [thread overview]
Message-ID: <52628f85-e41c-06de-a4a4-8d54148dfbf7@eastlink.ca> (raw)
In-Reply-To: <1239829800.2332805.1692110389939@mail.virginmedia.com>
On 2023-08-15 07:39, Peter Stephenson wrote:
>
> Yes, it's worth doing something... here's my go.
>
> +Tags the named parameters. Tags only exist to mark the parameter for
> +the user's own purposes: the set of tagged parameters can be queried
> +using `tt(typeset -t)'. They have no further special meaning to the
> +shell. This flag has a different meaning when used with tt(-f); see above.
> )
That is so much better. We go from a conveyed information score of -10
to +90 in one effort. Since there is no end to little edits (which have
an asymptotic convergence on perfection), I'd tweak it:
+Tags the named parameters. Tags only exist to 'flag' the parameter for
+the user's own purposes -- the list of tagged parameters can be queried
+using `tt(typeset -t)'. Tags have no other use. Note that the `-t` flag has a different meaning when used with tt(-f); see above.
)
'flag' because that's the word used lower down
'list' instead of 'set' because set sounds too mathematical
'no other use' is simpler than 'no further special meaning to the shell' -- there is no other, not just no other *special* -- it makes one wonder what an un-special meaning might be. And 'to the shell' makes one wonder what a use *outside the shell* might possibly be.
'-t' just keeps things specific.
And I'd add 'Note that' simply to flag the otherwise usage. It's polite.
I dream of a manual that is designed to inform the one seeking information rather than display the knowledge of the writer to himself.
next prev parent reply other threads:[~2023-08-15 15:17 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-15 5:51 Marlon Richert
2023-08-15 8:27 ` Peter Stephenson
2023-08-15 14:30 ` Ray Andrews
2023-08-15 14:39 ` Peter Stephenson
2023-08-15 15:16 ` Ray Andrews [this message]
2023-08-15 17:40 ` Lawrence Velázquez
2023-08-15 18:10 ` Ray Andrews
2023-08-15 22:41 ` Grant Taylor
2023-08-17 23:41 ` Clinton Bunch
2023-08-18 1:10 ` Bart Schaefer
2023-08-18 4:15 ` Ray Andrews
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=52628f85-e41c-06de-a4a4-8d54148dfbf7@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).