Zsh Mailing List Archive
Messages sorted by:
Reverse Date,
Date,
Thread,
Author
[PATCH] docs: clarify valid parameter names
- X-seq: zsh-workers 53636
- From: dana <dana@xxxxxxx>
- To: zsh-workers@xxxxxxx
- Subject: [PATCH] docs: clarify valid parameter names
- Date: Mon, 19 May 2025 05:15:18 -0500
- Archived-at: <https://zsh.org/workers/53636>
- Feedback-id: i9be146f9:Fastmail
- List-id: <zsh-workers.zsh.org>
someone on github who's working on a zsh syntax-highlighting definition
was misled by what the documentation says a parameter name may be. i
think this clarifies it
dana
diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo
index c52b6ba91..edf805927 100644
--- a/Doc/Zsh/params.yo
+++ b/Doc/Zsh/params.yo
@@ -4,9 +4,13 @@ cindex(parameters)
cindex(variables)
sect(Description)
A parameter has a name, a value, and a number of attributes.
-A name may be any sequence of alphanumeric
-characters and underscores, or the single characters
-`tt(*)', `tt(@)', `tt(#)', `tt(?)', `tt(-)', `tt($)', or `tt(!)'.
+User-assignable parameter names may contain alphanumeric characters,
+underscores, and (per the description of namespaces below) dots.
+They may not begin with a number, except for positional parameters
+(tt($1), tt($2), etc.), whose names consist em(only) of numbers. There
+are also special shell parameters with single-character names such as
+`tt(*)', `tt(@)', `tt(#)', `tt(?)', `tt(-)', `tt($)', and `tt(!)'.
+These are described below.
A parameter whose name begins with an alphanumeric or underscore is also
referred to as a em(variable).
Messages sorted by:
Reverse Date,
Date,
Thread,
Author