emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <n.goaziou@gmail.com>
To: Rainer M Krug <Rainer@krugs.de>
Cc: emacs-orgmode@gnu.org
Subject: Re: Should comments break paragraphs?
Date: Tue, 16 Jul 2013 09:40:13 +0200	[thread overview]
Message-ID: <87ehazymua.fsf@gmail.com> (raw)
In-Reply-To: <m2wqorj80p.fsf@krugs.de> (Rainer M. Krug's message of "Tue, 16 Jul 2013 09:09:26 +0200")

Hello,

Rainer M Krug <Rainer@krugs.de> writes:

> I see comments as "entities which do not have any impact on the final
> product". 
>
> If you regard the org file as the final product, then I
> completely agree (I use org mainly for literate programming, and I don't
> use any comments unless in linger code blocks, but that is not in
> org). But if I use org for writing e.g. presentations in beamer, I might want
> to add comments which should not be on the product (slides, article,
> handout, ...) but which contain info in the org file.
>
> So we are talking different levels here.

Comments do not alter the final product: they are ignored during export.
But there are places where you cannot have comments, at all. If we look
at the following example, similar to OP's:

  Some text
  # comment
  Some other text

comment do not split the paragraph: there were two paragraphs since the
beginning (but still no spoon). It's only disturbing if you think
comments can be inserted within paragraphs, which is not the case.

This may not be perfect, but, as for me, it's good enough.

Another option would be to remove every comment line before parsing the
buffer (which is, IIRC, what previous exporter did), but it would only
hide the situation for a while. After all I could expect to have
comments anywhere, including some places like

  * Headline
  # Between an headline and planning info. Update org-agenda.el.
  SCHEDULED: <2013-07-16 Tue>

  - item 1
  # Some comment between items. Update org-list.el
  - item 2

  #+HEADER: var=2
  # A comment between affiliated keywords and true data. Update ob-core.el.
  #+RESULTS: some-table
  | a |

  | a | b |
  # Comments within rows. Update org-table.el
  | c | d |

And then, the situation would appear again: it's not just about the parser
or the exporter. Every part of Org would have to handle comments differently.

Again, I think comments are acceptable, once you are aware about their
limitations. But, I don't prevent you from opening that can of worms.


Regards,

-- 
Nicolas Goaziou

  reply	other threads:[~2013-07-16  7:40 UTC|newest]

Thread overview: 45+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-07-15 18:48 Should comments break paragraphs? Kodi Arfer
2013-07-15 18:54 ` Nicolas Goaziou
2013-07-15 22:46   ` Christian Wittern
2013-07-16  6:53     ` Rainer M Krug
2013-07-16  6:59     ` Nicolas Goaziou
2013-07-16  7:09       ` Rainer M Krug
2013-07-16  7:40         ` Nicolas Goaziou [this message]
2013-07-16  8:09           ` Rainer M Krug
2013-07-16  8:19             ` Andreas Leha
2013-07-16  8:44               ` Nicolas Goaziou
2013-07-16  8:55                 ` Andreas Leha
2013-07-16 17:08                 ` Eric S Fraga
2013-07-16  8:26             ` Nicolas Goaziou
2013-07-16  8:21           ` Fabrice Popineau
2013-07-16  8:27             ` Fabrice Popineau
2013-07-16 15:46       ` Eric Schulte
2013-07-16 16:01         ` Nicolas Goaziou
2013-07-16 16:59           ` Eric Schulte
2013-07-16 17:51             ` Nicolas Goaziou
2013-07-17  5:28               ` Bastien
2013-07-17  7:17                 ` Nicolas Goaziou
2013-07-17  8:15                   ` Bastien
2013-07-17  9:00                     ` Nicolas Goaziou
2013-07-17 12:57                       ` Bastien
2013-07-17 13:21                         ` Rainer M Krug
2013-07-17 13:52                           ` Rasmus
2013-07-17 16:10                             ` Eric S Fraga
2013-07-18  7:02                               ` Christian Moe
2013-07-18  8:31                                 ` Eric Abrahamsen
2013-07-18  8:50                                   ` Rasmus
2013-07-18  9:50                                     ` Eric Abrahamsen
2013-07-18  8:47                                 ` Rasmus
2013-07-17 13:28                         ` Eric Schulte
2013-07-17 14:30                           ` Bastien
2013-07-17 13:47                         ` Nicolas Goaziou
2013-07-17 18:48                           ` Eric S Fraga
2013-07-17 19:04                             ` Nicolas Goaziou
2013-07-17 20:18                               ` Eric S Fraga
2013-07-17  7:11               ` Suvayu Ali
2013-07-17 12:54               ` Eric Schulte
2013-07-17 13:52                 ` Nicolas Goaziou
2013-07-17 22:05                 ` Andreas Leha
2013-07-17 22:11                   ` Eric Schulte
2013-07-17 22:34                     ` Andreas Leha
2013-07-18 11:23                     ` Nicolas Goaziou

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=87ehazymua.fsf@gmail.com \
    --to=n.goaziou@gmail.com \
    --cc=Rainer@krugs.de \
    --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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).