GNU bug report logs - #28237
25.2; doc string of `Info-virtual-nodes'

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 28237 in the body.
You can then email your comments to 28237 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 25.2; doc string of `Info-virtual-nodes'
Date: Fri, 25 Aug 2017 15:05:20 -0700 (PDT)

Neither OPERATION nor HANDLER is specified well.

1. These parts of the doc string are incomprehensible:

     OPERATION is one of the following operation symbols `find-node'
                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     that define what HANDLER function to call instead of calling the
     default corresponding function to override it.
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

   I can't even parse the first bit.  Is it trying to say that OPERATION
   must be `find-node'?  (No idea.)

   The second bit: what is the "default corresponding function"?  What
   does that mean?  Default wrt what?  Corresponding to what?

2. HANDLER is not specified at all.  No doubt it is a function.  But
   what arguments can or must the function accept?


In GNU Emacs 25.2.1 (x86_64-w64-mingw32)
 of 2017-04-24
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --without-dbus --without-compress-install 'CFLAGS=-O2
 -static -g3''

Message #8 received at 28237 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 28237 <at> debbugs.gnu.org
Subject: Re: bug#28237: 25.2; doc string of `Info-virtual-nodes'
Date: Mon, 15 Jul 2019 13:51:05 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

> Neither OPERATION nor HANDLER is specified well.
>
> 1. These parts of the doc string are incomprehensible:
>
>      OPERATION is one of the following operation symbols `find-node'
>                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>      that define what HANDLER function to call instead of calling the
>      default corresponding function to override it.
>      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
>    I can't even parse the first bit.  Is it trying to say that OPERATION
>    must be `find-node'?  (No idea.)
>
>    The second bit: what is the "default corresponding function"?  What
>    does that mean?  Default wrt what?  Corresponding to what?
>
> 2. HANDLER is not specified at all.  No doubt it is a function.  But
>    what arguments can or must the function accept?

Looks like Eli fixed this at the time but forgot to close this report.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.