emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: "Jorge P. de Morais Neto" <jorge@disroot.org>
To: emacs-orgmode@gnu.org
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	[thread overview]
Message-ID: <87a73gstpz.fsf@disroot.org> (raw)

* 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
thought:

    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.

Regards

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 @ /home/jorge/.emacs.d/elpa/27.0/develop/org-plus-contrib-20200406/)
-- 
- <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	other threads:[~2020-04-12 14:11 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-12 13:45 Jorge P. de Morais Neto [this message]
2020-04-12 22:35 ` Kyle Meyer
2020-04-13 11:59   ` Jorge P. de Morais Neto
2020-04-13 15:56     ` Kyle Meyer
2021-08-11 20:38 ` Jorge P. de Morais Neto
2021-08-11 20:50   ` Nicolas Goaziou
2021-08-11 21:53     ` Jorge P. de Morais Neto
2021-09-10  6:17       ` Timothy
2021-09-10 13:41         ` Jorge P. de Morais Neto

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=87a73gstpz.fsf@disroot.org \
    --to=jorge@disroot.org \
    --cc=emacs-orgmode@gnu.org \
    --subject='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/)]' \
    /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

Code repositories for project(s) associated with this 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).