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

From: Ken Mankoff <mankoff@gmail.com>
To: Org-mode <emacs-orgmode@gnu.org>
Subject: :comments org doesn't export comments below code
Date: Thu, 12 Jul 2018 06:44:06 -0400	[thread overview]
Message-ID: <m2va9klond.fsf@gmail.com> (raw)

Hi Org List,

I'm trying to understand the use-case of the ":comments org" header option. It seems like a nice way to generate code files with comments embedded in theory, but in practice I find it restrictive. I'm wondering if I'm misunderstanding its purpose, using it wrong, or have found a bug.

MWE:

========================================================
#+PROPERTY: header-args :comments org :tangle debug.sh 

* Foo

Foo text about Bar and Baz

** Bar
:PROPERTIES:
:SOMETHING: BAR VALUE
:END:

Bar pre text

#+BEGIN_SRC sh :results verbatim
echo "bar code"
#+END_SRC
#+RESULTS:

Bar post text

** Baz

Baz text

========================================================

Generates this:

========================================================

# Bar
# :PROPERTIES:
# :SOMETHING: BAR VALUE
# :END:

# Bar pre text
echo "bar code"

========================================================

The issues are 1) there is no "post text" exported. The "bar post text" discusses the results of the source block above it, but is not exported to the code file as comments, and 2) The Foo text is not exported either, but contains info relevant to the Bar code.

Is there a way to get more of the Org file embedded in the tangled code?

Thanks,

  -k.

next             reply	other threads:[~2018-07-12 10:44 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-12 10:44 Ken Mankoff [this message]
2018-07-14  8:10 ` :comments org doesn't export comments below code Nicolas Goaziou
2018-07-14 19:39   ` Grant Rettke
2018-07-14 21:25     ` Ken Mankoff

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=m2va9klond.fsf@gmail.com \
    --to=mankoff@gmail.com \
    --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).