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

From: Samuel Wales <samologist@gmail.com>
To: Nicolas Goaziou <n.goaziou@gmail.com>
Cc: Daniel Schoepe <daniel@schoepe.org>, emacs-orgmode@gnu.org
Subject: Comments and control lines (# vs. #+)
Date: Wed, 23 May 2012 10:02:58 -0700	[thread overview]
Message-ID: <CAJcAo8uR0TL3B3DpUxM7git-oB5ZSkE2G9csob_KtaqmA3PEHg@mail.gmail.com> (raw)

The following, which is general and I wrote a long time ago,
might also be relevant to the recent thread on comments
breaking lists.

===

There might be really good reasons for the #+ comment
convention in Org, but I am not sure what they are.  So
please bear with me.

This list is not complete or minimal.  Please disregard the
items you don't like.

===

Here are some of the reasons I prefer # to #+ as a
consistent commenting scheme for Org.

  1) #+ is not as standard as #
  2) there are tools for commenting and uncommenting regions
     with #, but not with #+
  3) many users have their own tools that do not
     understand #+
  4) imported (or pasted) text will often have # commenting
     and this will need special processing to make it work
     with Org
  5) fill functions and packages often don't understand #+
  6) plain # works in column 0 in Org, leading to user
     expectation that it will behave consistently in other
     columns as it does in most other languages that use #
  7) parsing commented comments is more complicated and
     error-prone when both are used
  8) internal and external parsers might or might not expect
     a more standard commenting scheme.
  9) indented #+ is not colored as a comment or a control
     line
  10) it is natural to want to do a block comment on a
      section of a list without breaking list structure.
      there are built-in tools for this.
  11) it is natural to want to do an indented comment on a
      single list item at the same level of indentation as
      the bullet
  12) there are tools for auto-fill and indentation within
      comments that take into account # but not #+
  13) some parsers probably expect a single character
  14) internal and external parsers might want a
      special-case-free commenting scheme
  15) #+ indicates an Org control line, so using it for
      comments overloads the syntax

Hope it's of some use.

Thanks.

Samuel

-- 
The Kafka Pandemic: http://thekafkapandemic.blogspot.com

next             reply	other threads:[~2012-05-23 17:03 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-05-23 17:02 Samuel Wales [this message]
2012-05-25  2:14 ` Comments and control lines (# vs. #+) Mark Shoulson
2012-08-02  9:47 ` Bastien
2012-08-07 22:05   ` Samuel Wales

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=CAJcAo8uR0TL3B3DpUxM7git-oB5ZSkE2G9csob_KtaqmA3PEHg@mail.gmail.com \
    --to=samologist@gmail.com \
    --cc=daniel@schoepe.org \
    --cc=emacs-orgmode@gnu.org \
    --cc=n.goaziou@gmail.com \
    /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).