Re: Bug: Small documentation errors [9.3.6 (9.3.6-29-g6a3dff-elpaplus @ /home/jorge/.emacs.d/elpa/27.0/develop/org-plus-contrib-20200406/)]

[Jorge P. de Morais Neto <jorge+list@disroot.org>]

[-- Attachment #1: 0001-doc-org-manual.org-Drawers-Clarify-M-TAB.patch --]
[-- Type: text/x-diff, Size: 1811 bytes --]

From d3c62edf7a713278432ebe1c72e4545b8a2b84e2 Mon Sep 17 00:00:00 2001
From: "Jorge P. de Morais Neto" <jorge+git@disroot.org>
Date: Wed, 11 Aug 2021 18:43:21 -0300
Subject: [PATCH] * doc/org-manual.org (Drawers): Clarify M-TAB

Provide example of completion over drawer keywords.  Also clarify the
footnote by qualifying "windows" as "graphical".
---
 doc/org-manual.org | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index d34d33561..467644453 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -1214,7 +1214,22 @@ Org mode uses this special drawer for storing properties (see
 [[*Properties and Columns]]).  You cannot use it for anything else.
 
 Completion over drawer keywords is also possible using
-{{{kbd(M-TAB)}}}[fn:16].
+{{{kbd(M-TAB)}}}[fn:16].  For example, if the buffer contains
+
+#+begin_example
+:foo:
+:end:
+
+:f★
+#+end_example
+
+#+texinfo: @noindent
+(where ★ indicates the location of point) then {{{kbd(M-TAB)}}} will
+complete the line as
+
+#+begin_example
+:foo:★
+#+end_example
 
 Visibility cycling (see [[*Visibility Cycling]]) on the headline hides and
 shows the entry, but keep the drawer collapsed to a single line.  In
@@ -21500,8 +21515,8 @@ variable ~org-M-RET-may-split-line~.
 
 [fn:15] See ~org-list-use-circular-motion~ for a cyclic behavior.
 
-[fn:16] Many desktops intercept {{{kbd(M-TAB)}}} to switch windows.
-Use {{{kbd(C-M-i)}}} or {{{kbd(ESC TAB)}}} instead.
+[fn:16] Many desktops intercept {{{kbd(M-TAB)}}} to switch graphical
+windows.  Use {{{kbd(C-M-i)}}} or {{{kbd(ESC TAB)}}} instead.
 
 [fn:17] To insert a vertical bar into a table field, use =\vert= or,
 inside a word =abc\vert{}def=.
-- 
2.32.0


[-- Attachment #2: Type: text/plain, Size: 1216 bytes --]

Hello,

Em [2021-08-11 qua 22:50:36+0200], Nicolas Goaziou escreveu:

>> Sorry for insisting, but can someone give me an example of what the
>> manual means by "Completion over drawer keywords"?
>
>   :foo:
>   :end:
>
>   :f|
>
> With point at |, M-TAB will complete the line as
>
>                                  :foo:

Then how about the attached patch?  Note that I used a black star to
indicate the position of point---the convention in the Elisp manual.
Also, I provided a ~+#+texinfo: @noindent~ directive so the continuation
would not be indented, because it is not a new paragraph.  Please tell
whether that made sense---I know little about Texinfo and typography.

Also tell whether I am making good use of time---mine and yours.  I have
OCD and I often nitpick about details of little relevance; feedback
about that is always welcome.

Regards

-- 
- Disinformation flourishes because many people care about injustice
  but very few check the facts.  Ask me about <https://stallmansupport.org>
- I am Brazilian.  I hope my English is correct and I welcome feedback.
- Free Software Supporter: https://www.fsf.org/free-software-supporter
- If an email of mine arrives at your spam box, please notify me.