[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Bug: Small documentation errors [9.3.6 (9.3.6-29-g6a3dff-elpaplus @ /hom

From: Jorge P. de Morais Neto
Subject: 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/)]
Date: Sun, 12 Apr 2020 10:45:44 -0300

* Small documentation errors

Hi.  Below I report a series of small documentation errors.  Please tell
me whether it was helpful to coalesce these several errors into one bug
report or I should have filed several reports.

** [[info:org#Sparse Trees]]

 The final paragraph recommends the command ‘C-c C-e v’ to export only
the visible part of the document.  The correct keybinding, however, is
‘C-c C-e C-v’.

** [[info:org#Plain Lists]]

The description of `C-c -' inverts the effect of the prefix argument.

** [[info:org#Drawers]]

I don't understand the sentence

       Completion over drawer keywords is also possible using ‘M-<TAB>’

Could give me a simple example of drawer keyword completion?

** [[info:org#TODO Basics]]

This section omits `C-S-<RET>'.  Is that intentional?

** [info:org#Tracking TODO state changes]

The following sentence is misplaced, interrupting the previous train of

    To record a timestamp without a note for TODO keywords configured
    with `@', just type `C-c C-c' to enter a blank note when prompted.

** Docstring of `org-time-stamp-inactive'

It has less information than the docstring of `org-time-stamp'.  If that
is intentional, then I suggest at least referring to the docstring of
`org-time-stamp' for more information.

Also, it says that inactive timestamp do not link to the calendar and
cannot be changed with the S-cursor keys; the actual behavior -- which I
tested both in an updated Spacemacs (develop branch) and in `emacs -q`
-- contradicts both assertions.

Finally, the last paragraph says:

    When called with two universal prefix arguments, insert an active
    time stamp with the current time without prompting the user.

Clearly it should say /inactive/ instead of /active/.

* Feedback

I am obsessed with detail and I welcome feedback about that.  Please
tell me whether I am nitpicking.


Emacs  : GNU Emacs 27.0.90 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.5)
 of 2020-04-11
Package: Org mode version 9.3.6 (9.3.6-29-g6a3dff-elpaplus @ 
- <https://jorgemorais.gitlab.io/justice-for-rms/>
- I am Brazilian.  I hope my English is correct and I welcome feedback.
- Please adopt free/libre formats like PDF, ODF, Org, LaTeX, Opus, WebM and 7z.
- Free/libre software for Replicant, LineageOS and Android: https://f-droid.org
- [[https://www.gnu.org/philosophy/free-sw.html][What is free software?]]

reply via email to

[Prev in Thread] Current Thread [Next in Thread]