all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: dieter@duenenhof-wilhelm.de (H. Dieter Wilhelm)
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: Stefan Kangas <stefan@marxist.se>,
	Emacs developers <emacs-devel@gnu.org>
Subject: Re: Info viewer: Links to symbol documentation
Date: Sun, 03 May 2020 12:51:56 +0200	[thread overview]
Message-ID: <86imhd2svn.fsf@duenenhof-wilhelm.de> (raw)
In-Reply-To: <jwvmu6zn2ik.fsf-monnier+emacs@gnu.org> (Stefan Monnier's message of "Sat, 25 Apr 2020 09:02:19 -0400")

Hello Emacs

FYI: 5 people reacted to the idea of furthering the self-documenting
capabilities - admittedly only a tiny step - for Emacs, but, at least
the feedback was positive.  So I thought it might be a good idea to
bring this package to Melpa, ripen the code and judge the interest
before it could be integrated into GNU-ELPA.

  https://melpa.org/#/inform

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>> Perhaps more elegantly, one could add links only when there is a
>> corresponding symbol in the obarray.
>
> That will suffer from false positives.

At the moment the linking is only done when variable -, function - and
font names are `quoted' or there is a prefix M-x for function names and
additionally, if all these symbols are in `obarray'.  I guess the
chances of false positives are therefore minuscule.

> Also for non-Emacs documentation, we could also add links but to the
> relevant part of the manual.

I had a look for the `automake' manual. I'm not sure what you have in
mind for this kind of documentation and therefore how to implement it..

Could you please give me a concrete example?

    Dieter

-- 
Best wishes
H. Dieter Wilhelm
Zwingenberg, Germany



  reply	other threads:[~2020-05-03 10:51 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-21 20:38 Info viewer: Links to symbol documentation H. Dieter Wilhelm
2020-04-25 10:16 ` Eli Zaretskii
2020-04-25 10:53   ` H. Dieter Wilhelm
2020-04-25 11:15   ` Basil L. Contovounesios
2020-04-25 16:04     ` Drew Adams
2020-04-25 17:22       ` H. Dieter Wilhelm
2020-04-25 17:34         ` Drew Adams
2020-04-25 12:03 ` Stefan Monnier
2020-04-25 12:22   ` Stefan Kangas
2020-04-25 13:02     ` Stefan Monnier
2020-05-03 10:51       ` H. Dieter Wilhelm [this message]
2020-05-03 14:46         ` Stefan Monnier
2020-05-03 16:02           ` H. Dieter Wilhelm
2020-04-25 13:21     ` H. Dieter Wilhelm

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

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

  git send-email \
    --in-reply-to=86imhd2svn.fsf@duenenhof-wilhelm.de \
    --to=dieter@duenenhof-wilhelm.de \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    --cc=stefan@marxist.se \
    /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 external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.