From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Tino Calancha Newsgroups: gmane.emacs.bugs Subject: bug#42050: 27.0.91; Clarify Info-next docstring Date: Thu, 25 Jun 2020 23:43:42 +0200 Message-ID: <87a70qkei9.fsf@calancha-pc.dy.bbexcite.jp> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="60734"; mail-complaints-to="usenet@ciao.gmane.io" Cc: uyennhi.qm@gmail.com To: 42050@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Jun 25 23:44:10 2020 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1joZfG-000Fgt-OL for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 25 Jun 2020 23:44:10 +0200 Original-Received: from localhost ([::1]:50866 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1joZfF-0006YA-F5 for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 25 Jun 2020 17:44:09 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:55644) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1joZf8-0006Xp-Iw for bug-gnu-emacs@gnu.org; Thu, 25 Jun 2020 17:44:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:58099) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1joZf8-0005Px-8Q; Thu, 25 Jun 2020 17:44:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1joZf8-0003Id-5c; Thu, 25 Jun 2020 17:44:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Tino Calancha Original-Sender: "Debbugs-submit" Resent-CC: eliz@gnu.org, uyennhi.qm@gmail.com, bug-gnu-emacs@gnu.org Resent-Date: Thu, 25 Jun 2020 21:44:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 42050 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org X-Debbugs-Original-Xcc: eliz@gnu.org,uyennhi.qm@gmail.com Original-Received: via spool by submit@debbugs.gnu.org id=B.159312143812665 (code B ref -1); Thu, 25 Jun 2020 21:44:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 25 Jun 2020 21:43:58 +0000 Original-Received: from localhost ([127.0.0.1]:41412 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1joZf4-0003ID-2Q for submit@debbugs.gnu.org; Thu, 25 Jun 2020 17:43:58 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:49554) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1joZf1-0003I4-DD for submit@debbugs.gnu.org; Thu, 25 Jun 2020 17:43:56 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:55630) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1joZf1-0006W7-66 for bug-gnu-emacs@gnu.org; Thu, 25 Jun 2020 17:43:55 -0400 Original-Received: from mail-ed1-x530.google.com ([2a00:1450:4864:20::530]:34628) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1joZez-0005No-LW for bug-gnu-emacs@gnu.org; Thu, 25 Jun 2020 17:43:54 -0400 Original-Received: by mail-ed1-x530.google.com with SMTP id a8so4182460edy.1 for ; Thu, 25 Jun 2020 14:43:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id:mime-version; bh=jZvL4bwvOW9fTR8iSx87yBOGV9D654DOXmrV7Fs+YdA=; b=YEbF3RimpciYYghCZpIPXvyo1MPxYC/gUvAu2qLyg2AbbVpOuotHkRV4i4hty6fDuo rRTjWaHzMdg2V4mBBCq3E8IkKAo2x8wkimx0anrBhHvahJzi2PR6cj9vbxbi0FZQldBD sokyyzh6MXCGlpyCgN4zLsqe2ApgwYEj4fxEqFX++PKKkQtI+/PhJBw+O7O/S1uvXWT/ PYZvz9iHRk0DjM4f4fCV2YX9frU7ekz0Gli+44Ha3fN+93zxvEZSVt8R5BtILWtQfRuX d/MwXtXAPKYMyThU2nv5OpYwSadwmncWZqRm2YOhpdK5JP+ckckh/MBTYliYpoaHQuD5 r1Pg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:mime-version; bh=jZvL4bwvOW9fTR8iSx87yBOGV9D654DOXmrV7Fs+YdA=; b=SF2O6oSQ3rrh+Tyuby9mENki4fToCokAC367t1UPqunuEozHyMvJtGBdBUCYzkSzbf dLVLa8m/zUCEkPUIL51lesvb4rjOTbhNYd3y4PbMHkDhtedfLGL0tyTniDf15x4RxGye ZTTEZ03nbJAOAf4HSyiSe/VjBZYqgwIm0/o0JnQL4et27gcjRS4CjP4349Y8rvuCslin 4Vq+zh0XlkHAdUNrdxx8XR85NRbd/p5dT2g1cogLxpTZoBYYNn8WVhOMTUamckEJfs9u bZ1mKKIqhLryZJ523MAlwXBvm8mLt8A0JVM6GqnX1ldwv6sOdUDvlEaQDwYa+Nwjv2rW go+A== X-Gm-Message-State: AOAM530PNNvqU2Lx8M7sriAfbZQdLotcXFpT0wR51SK8D6Gpm+71A7AZ Cj/W1qY8+nFwdNdSrADNg36+D0SYlLs= X-Google-Smtp-Source: ABdhPJwDEAXNSvHgTomY2aj0DiSnaHfE+oSZYQRsrBUXFvHvkTqq+4/wtGQIKqnDbec+YOAJtnMX8g== X-Received: by 2002:a50:9b18:: with SMTP id o24mr232284edi.335.1593121431555; Thu, 25 Jun 2020 14:43:51 -0700 (PDT) Original-Received: from calancha-pc.dy.bbexcite.jp ([31.7.242.222]) by smtp.gmail.com with ESMTPSA id m13sm7784573ejc.1.2020.06.25.14.43.50 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Jun 2020 14:43:51 -0700 (PDT) Received-SPF: pass client-ip=2a00:1450:4864:20::530; envelope-from=tino.calancha@gmail.com; helo=mail-ed1-x530.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -10 X-Spam_score: -1.1 X-Spam_bar: - X-Spam_report: (-1.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, FREEMAIL_REPLY=1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001 autolearn=_AUTOLEARN X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:182397 Archived-At: 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 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)