emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Thibault Polge <thibault@thb.lt>
To: emacs-orgmode@gnu.org
Subject: Discrepancy between documentation and implementation regarding comments
Date: Sun, 27 Oct 2019 11:07:20 +0100	[thread overview]
Message-ID: <87eeyyy013.fsf@thb.lt> (raw)

[-- Attachment #1: Type: text/plain, Size: 919 bytes --]

Hello,

According to Org-Mode documentation[1],

> Lines starting with zero or more whitespace characters followed by one
> ‘#’ and a whitespace are treated as comments and, as such, are not
> exported.

The actual implementation differs on a subtle detail: Org-Mode will
treat a line where the pound sign is immediatly followed by \n as a
comment.  I believe this is expected behavior, since it allows to
comment out multiple paragraphs, and behaves as expected even when using
`delete-trailing-whitespace`.

I'm asking this because Pandoc follows strictly the org documentation,
and treats a line containing only a pound sign as text.  I opened a bug
about this[2], where I've been asked –reasonably– to first make sure the
bug isn't actually in Org Mode.

[1] https://orgmode.org/manual/Comment-lines.html

[2] https://github.com/jgm/pandoc/issues/5856

All the best,

--
Thibault

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

next             reply	other threads:[~2019-10-27 10:07 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-27 10:07 Thibault Polge [this message]
2019-10-27 16:13 ` Discrepancy between documentation and implementation regarding comments Robert Pluim
2019-10-27 20:09   ` Adam Porter
2019-10-27 21:02     ` Samuel Wales
2019-10-28 11:05 ` Nicolas Goaziou
2019-10-28 11:42   ` Thibault Polge
2019-10-28 16:16     ` Nicolas Goaziou
2019-10-29 13:52       ` Robert Pluim
2019-10-29 14:14         ` Thibault Polge
2019-10-29 14:34           ` Robert Pluim

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=87eeyyy013.fsf@thb.lt \
    --to=thibault@thb.lt \
    --cc=emacs-orgmode@gnu.org \
    /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 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).