From: Marco Munari <mar21+dev.emacs.bugfix@allerta.it>
To: 46082@debbugs.gnu.org
Cc: "Kim F. Storm" <storm@cua.dk>
Subject: bug#46082: (texinfo) @ref says something lisp/info.el do not respect by default
Date: Sun, 24 Jan 2021 17:26:57 +0100 [thread overview]
Message-ID: <ywmwnw2fgha.fsf@nb.mm.homeunix.org.valid> (raw)
[-- Attachment #1: Type: text/plain, Size: 2187 bytes --]
Hi Kim,
I'm writing in relation to defcustom Info-hide-note-references t in lisp/info.el
a9efebd0ba1 (Kim 2002-11-01 306) (defcustom Info-hide-note-references t
because it's a bad default to proper info documentation
as said in (texinfo) @ref documentation
https://www.gnu.org/software/texinfo/manual/texinfo/html_node/_0040ref.html
,---------------------------------------------------------------------------
| 6.6 @ref
| @ref is nearly the same as @xref except that it does not generate a ‘See’
| in the printed output, just the reference itself.
| This makes it useful as the last part of a sentence.
|
| For example,
|
| For more information, @pxref{This}, and @ref{That}.
| produces in Info:
|
(*)| For more information, *note This::, and *note That::.
| and in printed output:
|
| For more information, see Section 1.1 [This], page 1, and Section 1.2 [That], page 2.
`---------------------------------------------------------------------------
but with current info.el default in emacs shows
(*)| For more information, see [This]., and see [That].
(
A part that with only two examples (texinfo) @ref it's not very clear that
there are three cases:
@ref
@xref
@pxref
)
As I intended it, the second "see" should absolutely not be present,
Info-hide-note-references is already customize-able to nil(=compliant)
or hide(my preference), but the current default of t is(seem to me)
not at all as designed in texinfo,
for example python info documentation was plenty of misplaced
``See`` ... ``.`` (which is the reason I looked into the origin of the
problem) and found it: @ref should have not a processing for info that
add "See" as should while processing @xref, than the pxref is to
distinguish printed rendering.
I will not insist over this trivial change,
if ever you disagree you can also ignore the request
Cheers,
Marco Munari
--
x(t),y(t) = th(3t-34.5)*e^[-(3t-34.5)^2]/2-4.3+e^(-1.8/t^2)/(.8*atg(t-
3)+2)(t-1.8)-.3th(5t-42.5),(1.4e^[-(3t-34.5)^2]+1-sgn[|t-8.5|-.5]*1.5*
|sin(pi*t)|^[2e^(-(t-11.5)^2)+.5+e^(-(.6t-3.3)^2)])/(.5+t)+1 ; 0<t<14
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Adjust default to respect (texinfo) @ref documentation (as long as @xref was not used in the interactive mode who write the documentation correctly did not thought to have a "See" added in front of the node) --]
[-- Type: text/x-patch, Size: 784 bytes --]
diff --git a/lisp/info.el b/lisp/info.el
index 13c57bdcd1..dc663bf761 100644
--- a/lisp/info.el
+++ b/lisp/info.el
@@ -1,6 +1,6 @@
;; info.el --- Info package for Emacs -*- lexical-binding:t -*-
-;; Copyright (C) 1985-1986, 1992-2020 Free Software Foundation, Inc.
+;; Copyright (C) 1985-1986, 1992-2021 Free Software Foundation, Inc.
;; Maintainer: emacs-devel@gnu.org
;; Keywords: help
@@ -303,7 +303,7 @@ Info-scroll-prefer-subnodes
:type 'boolean
:group 'info)
-(defcustom Info-hide-note-references t
+(defcustom Info-hide-note-references nil
"If non-nil, hide the tag and section reference in *note and * menu items.
If the value is t, the default, replace \"*note\" with \"see\".
If the value is `hide', remove \"*note\" without replacing it with anything.
next reply other threads:[~2021-01-24 16:26 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <87eegy6gtv.fsf@gnus.org>
2021-01-24 16:26 ` Marco Munari [this message]
2021-01-27 2:56 ` bug#46082: (texinfo) @ref says something lisp/info.el do not respect by default Lars Ingebrigtsen
2021-03-01 15:20 ` Lars Ingebrigtsen
[not found] ` <handler.46082.C.161461205518066.notifdonectrl.0@debbugs.gnu.org>
2021-03-01 19:22 ` bug#46082: acknowledged by developer (control message for bug #46082) Marco Munari
2021-03-01 20:10 ` Eli Zaretskii
2021-03-08 6:37 ` Marco Munari
2021-03-11 14:26 ` Eli Zaretskii
2021-04-09 16:59 ` bug#46082: (texinfo) @ref says something lisp/info.el do not respect by default 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=ywmwnw2fgha.fsf@nb.mm.homeunix.org.valid \
--to=mar21+dev.emacs.bugfix@allerta.it \
--cc=46082@debbugs.gnu.org \
--cc=storm@cua.dk \
/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).