From: Drew Adams <drew.adams@oracle.com>
To: Michael Albinus <michael.albinus@gmx.de>
Cc: 23865@debbugs.gnu.org, Jonathan Kotta <jpkotta@gmail.com>
Subject: bug#23865: 24.5; doc string of `tramp-remote-path'
Date: Wed, 29 Jun 2016 06:53:35 -0700 (PDT) [thread overview]
Message-ID: <b0d56ba6-5b42-49b1-819e-f55aa86085e2@default> (raw)
In-Reply-To: <87oa6ke91x.fsf@gmx.de>
> The docstring of `tramp-remote-path' is oriented to the custom
> interface. In custom, `tramp-default-remote-path' and
> `tramp-own-remote-path' are not offered under their symbol name, but as
> "Default Directories" and "Private Directories". These entries are
> documented.
Right. That's the (doc) bug. It is fine to be "oriented" to
interactive use of Customize. It is a failing to incorrectly
describe the variable value. That hurts, rather than helps
users. The doc string can do both: describe things in terms
of the UI and also correctly describe the possible values.
What it should not do is what it does now: give the impression
that the list values are all strings (and not say anything
about those two symbols that have special meaning for the
variable value).
next prev parent reply other threads:[~2016-06-29 13:53 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-28 20:30 bug#23865: 24.5; doc string of `tramp-remote-path' Drew Adams
2016-06-28 20:36 ` Jonathan Kotta
2016-06-28 20:57 ` Drew Adams
2016-06-29 7:41 ` Michael Albinus
2016-06-29 13:53 ` Drew Adams [this message]
2016-06-29 14:58 ` Michael Albinus
2016-06-29 15:09 ` Drew Adams
2016-06-29 15:21 ` Eli Zaretskii
2016-06-29 16:11 ` Michael Albinus
2016-06-29 16:36 ` Eli Zaretskii
2016-06-30 11:17 ` Jiege Chen
2016-06-30 13:41 ` Michael Albinus
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=b0d56ba6-5b42-49b1-819e-f55aa86085e2@default \
--to=drew.adams@oracle.com \
--cc=23865@debbugs.gnu.org \
--cc=jpkotta@gmail.com \
--cc=michael.albinus@gmx.de \
/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).