help / color / mirror / code / Atom feed
From: "Daniel Shahaf" <d.s@daniel.shahaf.name>
To: zsh-workers@zsh.org
Subject: Re: [PATCH 2/2] Add ${==spec} syntax more discoverable in docs
Date: Sun, 26 Sep 2021 03:47:07 +0000	[thread overview]
Message-ID: <a5583100-2f5d-466e-a663-b14e5b5e3c01@www.fastmail.com> (raw)
In-Reply-To: <13541632399773@mail.yandex.ru>

ivan tkachenko wrote on Thu, 23 Sep 2021 12:31 +00:00:
> Also, I'd like to note that other sections of the Expansion chapter 
> such as "14.3.1 Parameter Expansion Flags" need some template 
> decorations too. I mean, try to search the page for, let's say, a 
> letter "t".

+1.  We _could_ add parentheses around the flags, e.g.,
«item(+LPAR()%+RPAR())» rather than «item(%)», so grepping for one-letter
flags would be easier.  We already do this in the prompt expansion
expandos documentation, for instance.  Would you like to do the honours?

FWIW, I think most of us generally search for «t» as a whole word, or
use the man page and search for /^ *t\>/ (or perhaps fgrep the
documentation sources for «item(tt(t»…).

> Unless you are a *NIX shell guru and know exactly where and 
> what to look for, you are toast.

Well, one does need to know what part of the documentation to read, but
that doesn't require or imply being a guru.

> Readability and discoverability of this documentation can/should be
> improved by a lot.

Any specific observations or suggestions?



      parent reply	other threads:[~2021-09-26  6:21 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-22 21:17 [PATCH 1/2] cosmit: Remove trailing whitespaces in expn.yo ivan tkachenko
2021-09-22 21:17 ` [PATCH 2/2] Add ${==spec} syntax more discoverable in docs ivan tkachenko
2021-09-22 22:48   ` Lawrence Velázquez
2021-09-23 12:31     ` ivan tkachenko
2021-09-23 12:49       ` [PATCH 1/2] cosmit: Remove trailing whitespaces in expn.yo ivan tkachenko
2021-09-23 12:49         ` [PATCH 2/2] Make Parameter Expansion syntax more discoverable in docs ivan tkachenko
2021-09-26  3:47       ` Daniel Shahaf [this message]

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:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=a5583100-2f5d-466e-a663-b14e5b5e3c01@www.fastmail.com \
    --to=d.s@daniel.shahaf.name \
    --cc=zsh-workers@zsh.org \


* 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


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).