unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefan@marxist.se>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 25406@debbugs.gnu.org
Subject: bug#25406: 24.5; doc string of `Info-history'
Date: Fri, 5 Jul 2019 14:17:39 +0200	[thread overview]
Message-ID: <CADwFkmmV5Kb2Jb7HjT3qVNNqoPj+L-L8YiMuEGfALbSiT_FOPA@mail.gmail.com> (raw)
In-Reply-To: <0952e732-0d5d-48a2-afe0-e44bfc10cae6@default>

Eli Zaretskii <eliz@gnu.org> writes:

>> Date: Mon, 9 Jan 2017 08:39:13 -0800 (PST)
>> From: Drew Adams <drew.adams@oracle.com>
>>
>> The doc string of `Info-find-emacs-command-nodes' refers you to variable
>> `Info-history' for the format of the locations.
>>
>> But the doc for `Info-history' says nothing about FILENAME, NODENAME,
>> and BUFFERPOS.
>>
>> Instead, those are described in `Info-find-emacs-command-nodes'.
>
> Yes, and that is consistent with the text of the doc string.
>
>> Something is backwards here, and/or missing.  Why refer to "the format
>> used in the variable `Info-history' if consulting that variable tells
>> you less about the format that what you are told before sending you
>> there?
>
> While the reference to Info-history might be redundant to some degree,
> I see nothing wrong with it -- or the rest of the text.
>
>>  ", where BUFFERPOS is the line number
>>  of the first element of the returned list (which is treated specially
>>  in `Info-goto-emacs-command-node'), and 0 for the other elements of
>>  the list."
>>
>> But why the parenthetical remark, and what it really means, I have
>> no idea.
>
> It is a hint for why BUFFERPOS is non-zero only in that first element.
> That hint is only important to someone who wants to understand how the
> code works.

It seems to me that the conclusion here is to do nothing.  Can we close
this bug report or am I missing something?

Best regards,
Stefan Kangas





  parent reply	other threads:[~2019-07-05 12:17 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-09 16:39 bug#25406: 24.5; doc string of `Info-history' Drew Adams
2017-01-09 18:36 ` Eli Zaretskii
2019-07-05 12:17 ` Stefan Kangas [this message]
2019-07-05 12:38   ` Eli Zaretskii
2019-08-02 14:02     ` 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=CADwFkmmV5Kb2Jb7HjT3qVNNqoPj+L-L8YiMuEGfALbSiT_FOPA@mail.gmail.com \
    --to=stefan@marxist.se \
    --cc=25406@debbugs.gnu.org \
    --cc=eliz@gnu.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).