unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Gregory Heytings via "Emacs development discussions." <emacs-devel@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: Lars Ingebrigtsen <larsi@gnus.org>, Eli Zaretskii <eliz@gnu.org>,
	emacs-devel@gnu.org
Subject: RE: master 2a7488d: Add support for displaying short documentation for function groups
Date: Mon, 12 Oct 2020 16:50:44 +0000	[thread overview]
Message-ID: <alpine.NEB.2.22.394.2010121832210453.20603@sdf.lonestar.org> (raw)
In-Reply-To: <5657b8b2-59ee-45e8-b851-5c93da82bd82@default>


>
> But you also said that you think we cannot provide such links 
> automatically.  And my response to that is that we can.  And I have.
>

We can in theory, but it would be too inefficient, as you said yourself. 
I think that checking the indexes of the sixty info files whenever a 
*Help* buffer is opened is not feasible.

>
> So far, we have _VERY_ few manually provided links. Nothing is stopping 
> someone from proposing adding this or that link manually.  Still, we 
> have very few, so far.
>

It was the meaning of my proposal.  Now it has to be done, of course. 
But for this there needs to be an agreement that it's a good thing to do.

>> For example, the docstring of kill-buffer would have two links, one to 
>> (info "(emacs)Buffers") and another one to (info "(elisp)Buffers"), 
>> with some explanation.  For example:
>>
>> See also the following manual chapters: for interactive use, see 
>> `(emacs) Buffers'; for Emacs Lisp programming use, see `(elisp) 
>> Buffers'.
>
> And for `kill-buffer' the `manuals' link gives you an Info Index buffer 
> with these two links:
>
> * kill-buffer [elisp]:   (elisp)Killing Buffers. (line 31)
> * kill-buffer [emacs]:   (emacs)Kill Buffer. (line 22)
>
> I think those are more appropriate targets than your `Buffers' nodes.
>

I do not think so.  Remember that what triggered my proposal was a 
question by RMS: how to make manuals easier to access by newcomers.  If 
you provide these newcomers with three similar versions of the same 
information (the docstring of kill-buffer, the documentation of 
kill-buffer in the Emacs manual, the documentation of kill-buffer in the 
Emacs Lisp manual), they will not see the point of reading the manuals. 
If you point them to the beginning of a chapter, they will see something 
different, in which they can expect to (and will) find information about 
the context of the command or function, for example, what the related 
concepts are, and what other related functions can do.  A manual is a 
manual, not a dictionary.

>
> They're different, yes, but not profoundly different.
>

It depends how you define profound ;-)

>
> And the inefficiency I referred to is likely from my insufficient 
> knowledge of using `info-lookup'.
>

I do not think so, but I would be happy to be proven wrong.  It seems to 
me that searching the indexes of sixty info files takes time.



  reply	other threads:[~2020-10-12 16:50 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20201011035127.7723.3256@vcs0.savannah.gnu.org>
     [not found] ` <20201011035128.E3FD320667@vcs0.savannah.gnu.org>
2020-10-11  3:55   ` master 2a7488d: Add support for displaying short documentation for function groups Lars Ingebrigtsen
2020-10-11 13:49     ` Eli Zaretskii
2020-10-11 21:47       ` Lars Ingebrigtsen
2020-10-11 23:38         ` Drew Adams
2020-10-12  8:05           ` Gregory Heytings via Emacs development discussions.
2020-10-12 16:20             ` Drew Adams
2020-10-12 16:50               ` Gregory Heytings via Emacs development discussions. [this message]
2020-10-12 17:29                 ` Drew Adams
2020-10-13 20:05     ` Juri Linkov
2020-10-13 20:35       ` Drew Adams
2020-10-14  7:48         ` Juri Linkov
2020-10-13 20:55       ` T.V Raman
2020-10-14  7:52         ` Juri Linkov
2020-10-14 14:41           ` T.V Raman
2020-10-14  4:12       ` Lars Ingebrigtsen
2020-10-14  7:59         ` Juri Linkov
2020-10-15  6:43           ` Lars Ingebrigtsen
2020-10-15 12:24             ` Stefan Monnier
2020-10-18 20:12               ` Juri Linkov
2020-10-19  3:47                 ` Richard Stallman
2020-10-19  8:05                   ` Juri Linkov
2020-10-23 20:24     ` Stefan Kangas
2020-10-24 19:59       ` Lars Ingebrigtsen
2020-10-24 23:51         ` Stefan Kangas
2020-10-25 13:04           ` Lars Ingebrigtsen
2020-10-27 13:48       ` Basil L. Contovounesios
2020-10-27 14:33         ` Stefan Kangas
2020-10-27 15:43           ` Basil L. Contovounesios
2020-10-27 17:33             ` Lars Ingebrigtsen
2020-10-27 22:02               ` Stefan Kangas
2020-10-28  8:20                 ` Mattias Engdegård
2020-10-28 13:50                   ` Stefan Kangas
2020-10-28 11:04                 ` Lars Ingebrigtsen
     [not found]   ` <CADwFkmnXuyh2cAddLtgTNmsSv8av3o9qk98CVcTAzq6B8Lrpkw@mail.gmail.com>
     [not found]     ` <87blgknjze.fsf@gnus.org>
2020-10-30 11:58       ` Stefan Kangas
2020-10-30 12:05         ` Lars Ingebrigtsen
2020-10-30 12:27           ` Stefan Kangas

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=alpine.NEB.2.22.394.2010121832210453.20603@sdf.lonestar.org \
    --to=emacs-devel@gnu.org \
    --cc=drew.adams@oracle.com \
    --cc=eliz@gnu.org \
    --cc=ghe@sdf.org \
    --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).