From: yuvallangerontheroad <yuvallangerontheroad@proton.me>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: "emacs-orgmode@gnu.org" <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] Explain how to end a buffer narrowing.
Date: Tue, 29 Nov 2022 18:20:24 +0000 [thread overview]
Message-ID: <4042lqgWuT9V_iup06oM6vwmGJZUibs3dC_0WbJbw6vuoXQyz_JmsNUmMWOqmfDpLcg3gj8ke324mV-vnxajySAxFiqLSmaH1OrSTYpTJn4=@proton.me> (raw)
In-Reply-To: <87tu2mlace.fsf@localhost>
[-- Attachment #1: Type: text/plain, Size: 1046 bytes --]
On Saturday, November 26th, 2022 at 04:26, Ihor Radchenko <yantar92@posteo.net> wrote:
> yuvallangerontheroad yuvallangerontheroad@proton.me writes:
>
> > > Extra [...] are redundant.
> > > Please test the patch before submitting.
> >
> > Sorry. Removed redundant brackets.
>
>
> Thanks.
:)
> It is also a good idea to add quotes around the command key. See the
> example in 25.3 Substituting Key Bindings in Documentation
> (I am honestly not sure how important quoting is, but let's better
> follow the Elisp manual).
Hopefully done.
> Also, please make the commit message more concrete.
>
> Maybe something like
>
> org: Mention how to widen in docstrings of the commands that do narrowing
Hopefully done.
> Finally, please follow the commit message format as described in
> https://orgmode.org/worg/org-contribute.html#commit-messages
> In particular, add the changelog entries and TINYCHANGE cookie (I assume
> that you don't have FSF copyright assignment).
Hopefully done.
Please review.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-lisp-org.el-Mention-how-to-widen-in-docstrings-of-co.patch --]
[-- Type: text/x-patch; name=0001-lisp-org.el-Mention-how-to-widen-in-docstrings-of-co.patch, Size: 2236 bytes --]
From f53b141bd2057898f2606e884cf1a094876696c2 Mon Sep 17 00:00:00 2001
From: Yuval Langer <yuvallangerontheroad@proton.me>
Date: Fri, 25 Nov 2022 16:40:50 +0200
Subject: [PATCH] lisp/org.el: Mention how to widen in docstrings of commands
that do narrowing
lisp/org.el: (org-narrow-to-subtree, org-toggle-narrow-to-subtree,
org-narrow-to-block, org-narrow-to-element) Mention how to widen in
docstrings of commands that do narrowing.
TINYCHANGE
---
lisp/org.el | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/lisp/org.el b/lisp/org.el
index 472e87b9b..2a1024c89 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -7220,7 +7220,8 @@ If yes, remember the marker and the distance to BEG."
(setq org-markers-to-move nil))
(defun org-narrow-to-subtree (&optional element)
- "Narrow buffer to the current subtree."
+ "Narrow buffer to the current subtree.
+Use the command `\\[widen]' to see the whole buffer again."
(interactive)
(if (org-element--cache-active-p)
(let* ((heading (org-element-lineage
@@ -7242,7 +7243,8 @@ If yes, remember the marker and the distance to BEG."
(point))))))))
(defun org-toggle-narrow-to-subtree ()
- "Narrow to the subtree at point or widen a narrowed buffer."
+ "Narrow to the subtree at point or widen a narrowed buffer.
+Use the command `\\[widen]' to see the whole buffer again."
(interactive)
(if (buffer-narrowed-p)
(progn (widen) (message "Buffer widen"))
@@ -7250,7 +7252,8 @@ If yes, remember the marker and the distance to BEG."
(message "Buffer narrowed to current subtree")))
(defun org-narrow-to-block ()
- "Narrow buffer to the current block."
+ "Narrow buffer to the current block.
+Use the command `\\[widen]' to see the whole buffer again."
(interactive)
(let* ((case-fold-search t)
(blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
@@ -21162,7 +21165,8 @@ ones already marked."
(goto-char (org-element-property :begin element))))))
(defun org-narrow-to-element ()
- "Narrow buffer to current element."
+ "Narrow buffer to current element.
+Use the command `\\[widen]' to see the whole buffer again."
(interactive)
(let ((elem (org-element-at-point)))
(cond
--
2.30.2
next prev parent reply other threads:[~2022-11-29 18:21 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-24 17:55 [PATCH] Explain how to end a buffer narrowing yuvallangerontheroad
2022-11-25 14:32 ` Ihor Radchenko
2022-11-25 14:44 ` yuvallangerontheroad
2022-11-25 14:52 ` Ihor Radchenko
2022-11-25 15:02 ` yuvallangerontheroad
2022-11-26 2:26 ` Ihor Radchenko
2022-11-29 18:20 ` yuvallangerontheroad [this message]
2022-12-05 11:25 ` Ihor Radchenko
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.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='4042lqgWuT9V_iup06oM6vwmGJZUibs3dC_0WbJbw6vuoXQyz_JmsNUmMWOqmfDpLcg3gj8ke324mV-vnxajySAxFiqLSmaH1OrSTYpTJn4=@proton.me' \
--to=yuvallangerontheroad@proton.me \
--cc=emacs-orgmode@gnu.org \
--cc=yantar92@posteo.net \
/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/org-mode.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).