branch: externals/org-remark
commit 6f1a13dbf186dad8b4e8dd6a3475a690afaddfaa
Author: Noboru Ota <m...@nobiot.com>
Commit: Noboru Ota <m...@nobiot.com>
doc: om-remove, C-u option
---
README.org | 4 +++-
org-marginalia.el | 6 ++++++
2 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
index 1b5ce98874..779e19eccb 100644
--- a/README.org
+++ b/README.org
@@ -90,7 +90,9 @@ Move your cursor on the highlighted text, and call
=org-marginalia-open= to open
This command visits the marginalia file and loads the saved highlights onto
the current buffer. If there is no margin notes for it, it will output a
message in the echo. Highlights tracked locally by Org-marginalia cannot
persist when you kill the buffer, or quit Emacs. When you re-launch Emacs,
ensure to turn on =org-marginalia-mode= to load the highlights. Loading is
automatically done when you activate the minor mode.
- =org-marginalia-remove= ::
-This command removes the highlight at point. It will remove the highlight, and
remove the properties from the marginalia, but will keep the headline and notes
in tact.
+This command removes the highlight at point. It will remove the highlight, and
remove the properties from the marginalia, but will keep the headline and notes
in tact.
+
+You can pass a universal argument (=C-u= by default). If this is the case, the
command additionally deletes the entire heading subtree, along with the notes
you have written, for the highlight.
- =org-marginalia-next= ::
Move to the next highlight if any. If there is none below the cursor, and
there is a highlight above, loop back to the top one.
diff --git a/org-marginalia.el b/org-marginalia.el
index 4d80d4653b..8706e3e78f 100644
--- a/org-marginalia.el
+++ b/org-marginalia.el
@@ -88,6 +88,12 @@
;; This command removes the highlight at point. It will remove the highlight,
;; and remove the properties from the marginalia, but will keep the headline
;; and notes in tact.
+;;
+;; You can pass a universal argument with
+;; \\[universal-argument] (ARG). If this is the case, the command
+;; additionally deletes the entire heading subtree, along with the
+;; notes you have written, for the highlight."
+
;; - `org-marginalia-next' (C-c n ] by default) ::
;; Move to the next highlight if any. If there is none below the cursor, and
