From: Tino Calancha <tino.calancha@gmail.com>
To: 42050@debbugs.gnu.org
Cc: uyennhi.qm@gmail.com
Subject: bug#42050: 27.0.91; Clarify Info-next docstring
Date: Thu, 25 Jun 2020 23:43:42 +0200 [thread overview]
Message-ID: <87a70qkei9.fsf@calancha-pc.dy.bbexcite.jp> (raw)
Severity: wishlist,patch
X-Debbugs-Cc: eliz@gnu.org,uyennhi.qm@gmail.com
When I am reading a section of the Emacs manual, then I
often assume that `p' and `n' behavior is like when you are
reading a book, i.e. jump to the prev/next page; i.e., my
natural expectation is that `n' is bound to `Info-forward-node'.
I think their docstrings could add some
description and mention to the other existent command.
You get my point in this patch:
--8<-----------------------------cut here---------------start------------->8---
commit 6a8f77a63bb5a57448f6184f96b3ca971e6d7991
Author: Tino Calancha <tino.calancha@gmail.com>
Date: Thu Jun 25 23:29:34 2020 +0200
Clarify Info-next docstring
Mention that Info-next doesn't descend into sublevels; also
mention the existence of Info-forward-node.
* lisp/info.el (Info-next)
(Info-prev)
(Info-forward-node)
(Info-backward-node): Clarify docstring.
diff --git a/lisp/info.el b/lisp/info.el
index 7a11bb3ff9..234d1d9f5f 100644
--- a/lisp/info.el
+++ b/lisp/info.el
@@ -2265,7 +2265,11 @@ Info-following-node-name
(match-string-no-properties 1)))
(defun Info-next ()
- "Go to the next node of this node."
+ "Go to the next node of this node.
+This moves to the next node within the same hierarchical level, i.e.,
+it doesn't descend into a sublevel.
+
+See also `Info-forward-node'."
(interactive)
;; In case another window is currently selected
(save-window-excursion
@@ -2273,7 +2277,11 @@ Info-next
(Info-goto-node (Info-extract-pointer "next"))))
(defun Info-prev ()
- "Go to the previous node of this node."
+ "Go to the previous node of this node.
+This moves to the previous node within the same hierarchical level, i.e.,
+it doesn't ascend into an upper level.
+
+See also `Info-backward-node'."
(interactive)
;; In case another window is currently selected
(save-window-excursion
@@ -2887,7 +2895,9 @@ Info-final-node
(Info-goto-node (Info-extract-menu-counting nil)))))
(defun Info-forward-node (&optional not-down not-up no-error)
- "Go forward one node, considering all nodes as forming one sequence."
+ "Go forward one node, considering all nodes as forming one sequence.
+Interactively, this is similar as `Info-next' but it also
+descends into sublevels."
(interactive)
(goto-char (point-min))
(forward-line 1)
@@ -2922,7 +2932,9 @@ Info-forward-node
(t (user-error "No pointer forward from this node")))))
(defun Info-backward-node ()
- "Go backward one node, considering all nodes as forming one sequence."
+ "Go backward one node, considering all nodes as forming one sequence.
+Interactively, this is similar as `Info-prev' but it also
+ascends into upper levels."
(interactive)
(let ((prevnode (Info-extract-pointer "prev[ious]*" t))
(upnode (Info-extract-pointer "up" t))
--8<-----------------------------cut here---------------end--------------->8---
In GNU Emacs 27.0.91 (build 26, x86_64-pc-linux-gnu, GTK+ Version 3.24.5)
of 2020-06-25 built on calancha-pc.dy.bbexcite.jp
Repository revision: 632b0119e1ac0b907af41e4e4b7b5ab7557a5d90
Repository branch: emacs-27
Windowing system distributor 'The X.Org Foundation', version 11.0.12004000
System Description: Debian GNU/Linux 10 (buster)
next reply other threads:[~2020-06-25 21:43 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-25 21:43 Tino Calancha [this message]
2020-06-26 7:43 ` bug#42050: 27.0.91; Clarify Info-next docstring Eli Zaretskii
2020-06-26 8:41 ` Basil L. Contovounesios
2020-06-26 10:31 ` Eli Zaretskii
2020-06-26 11:32 ` Basil L. Contovounesios
[not found] ` <handler.42050.D42050.159315742012378.notifdone@debbugs.gnu.org>
2020-06-26 15:36 ` bug#42050: closed (Re: bug#42050: 27.0.91; Clarify Info-next docstring) Tino Calancha
2020-06-26 17:53 ` Eli Zaretskii
2020-06-28 16:48 ` Tino Calancha
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=87a70qkei9.fsf@calancha-pc.dy.bbexcite.jp \
--to=tino.calancha@gmail.com \
--cc=42050@debbugs.gnu.org \
--cc=uyennhi.qm@gmail.com \
/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.