unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: "Stephen J. Turnbull" <stephen@xemacs.org>
Cc: emacs-devel <emacs-devel@gnu.org>
Subject: RE: Changes in revision 114466
Date: Tue, 1 Oct 2013 00:44:33 -0700 (PDT)	[thread overview]
Message-ID: <d3269127-399e-4e73-b09d-6a1fc5de24ad@default> (raw)
In-Reply-To: <87ob79ed1l.fsf@uwakimon.sk.tsukuba.ac.jp>

>  > But users are not necessarily aware of it.
> 
> Isn't that what should be fixed, then?

1) How?  2) It's still good to provide a visual cue that a given term
is in the manual.

>  > It would be good to provide explicit (visible) links for some symbols
>  > in some doc strings.
> 
> Which ones and which ones?  

It would be a matter of judgment, case by case.  Unless you decide
that every (documented) symbol gets a link programmatically, which
might be too busy visually.  Would it be only symbols enclosed in
`...' (yes)?

Some of those are already linked to other *Help* entries, of course.
Maybe such links to the manual should be distinguished visually from
links within *Help*.

We do have links to source files, which appear the same as links
within *Help*.  But if we start adding lots of links to the manuals
for defined symbols then it might help to tell the difference from
links within *Help*.

Maybe distinguish links to the manuals using :underline with
style `wave'?  Maybe use that for any link (e.g. source file target)
that leaves *Help*?

> And why is that better (or easier to achieve) than having access
> for all symbols in all docstrings at the user's option?

Doing it automatically is no doubt easier, not harder, than doing it
using judgment case by case.

At the user's option sounds good.  Systematically might be too much
for some people.



  reply	other threads:[~2013-10-01  7:44 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <mailman.53349.1380335551.10747.emacs-diffs@gnu.org>
2013-09-28  7:46 ` Changes in revision 114466 Eli Zaretskii
2013-09-28 22:30   ` Xue Fuqiao
2013-09-29  2:36     ` Eli Zaretskii
2013-09-29  7:24       ` Thien-Thi Nguyen
2013-09-30  4:55         ` Xue Fuqiao
2013-09-30  5:21           ` Drew Adams
2013-09-30 10:29             ` Stephen Berman
2013-09-30 15:05               ` Drew Adams
2013-09-30 15:52                 ` Thien-Thi Nguyen
2013-10-01  2:11                 ` Stephen J. Turnbull
2013-09-30 15:42               ` Eli Zaretskii
2013-09-30 11:47             ` Andreas Röhler
2013-09-30 15:38           ` Eli Zaretskii
     [not found]           ` <<83k3hye2uq.fsf@gnu.org>
2013-09-30 16:38             ` Drew Adams
2013-10-01  3:40               ` Xue Fuqiao
2013-10-01  4:57                 ` Stephen J. Turnbull
2013-10-01  5:15                   ` Drew Adams
2013-10-01  5:27                     ` Drew Adams
2013-10-01  6:11                     ` Stephen J. Turnbull
2013-10-01  7:44                       ` Drew Adams [this message]
2013-10-01  8:29                         ` Stephen J. Turnbull

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=d3269127-399e-4e73-b09d-6a1fc5de24ad@default \
    --to=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    --cc=stephen@xemacs.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).