From: Stefan Kangas <stefan@marxist.se>
To: Drew Adams <drew.adams@oracle.com>
Cc: Lars Ingebrigtsen <larsi@gnus.org>, 11571@debbugs.gnu.org
Subject: bug#11571: 24.0.97; doc string of `dired-get-subdir-min'
Date: Tue, 05 Nov 2019 16:09:32 +0100 [thread overview]
Message-ID: <871rum742b.fsf@marxist.se> (raw)
In-Reply-To: <7374f5d9-6d88-4351-bd63-b526ea0d3486@default> (Drew Adams's message of "Fri, 1 Nov 2019 13:54:55 -0700 (PDT)")
Drew Adams <drew.adams@oracle.com> writes:
> The use of cdr is clear enough, as long as you
> understand what `dired-subdir-alist' is.
>
> But that could be clearer.
>
> `C-h v dired-subdir-alist' says:
>
> Association list of subdirectories and their buffer positions.
> Each subdirectory has an element: (DIRNAME . STARTMARKER).
> ...
>
> Directories don't have buffer positions.
>
> It would be clearer to say "listed subdirectories".
> It's not about subdirectories. It's about those
> subdirs that are listed in the Dired buffer, and
> STARTMARKER is the buffer position where such a
> _listing_ starts.
>
> The buffer position of a subdirectory isn't clear.
> The buffer position of a subdirectory listing is
> clear.
FWIW, I think it's already clear enough, given that the value after
dired-maybe-insert-subdir will be something like:
(("/home/skangas/wip/emacs/etc/" . #<marker at 3031 in emacs>)
("/home/skangas/wip/emacs/" . #<marker at 1 in emacs>))
I'm not against trying to make it even clearer though.
Do you have a suggestion for how to rewrite this text without going
over the recommended 67 character limit?
Association list of subdirectories and their buffer positions.
The best I could come up with is this (exactly 67 characters):
Alist of subdirectories and the buffer positions of their listings.
Best regards,
Stefan Kangas
next prev parent reply other threads:[~2019-11-05 15:09 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-05-27 21:37 bug#11571: 24.0.97; doc string of `dired-get-subdir-min' Drew Adams
2012-05-27 21:41 ` Drew Adams
2012-09-16 23:49 ` Drew Adams
2014-02-09 3:59 ` Lars Ingebrigtsen
2014-02-09 22:25 ` Drew Adams
2019-11-01 18:44 ` Stefan Kangas
2019-11-01 20:54 ` Drew Adams
2019-11-05 15:09 ` Stefan Kangas [this message]
2019-11-05 16:21 ` Drew Adams
2019-11-08 13:30 ` Stefan Kangas
2019-11-08 18:04 ` Drew Adams
2019-11-10 21:17 ` Stefan Kangas
2019-11-02 14:51 ` Lars Ingebrigtsen
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=871rum742b.fsf@marxist.se \
--to=stefan@marxist.se \
--cc=11571@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
--cc=larsi@gnus.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.savannah.gnu.org/cgit/emacs.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).