Re: [Patch] ob-tangle.el: New value 'ascii' for the header argument ':comments'

[Ihor Radchenko]

Juan Manuel Macías <maciaschain@posteo.net> writes:

>> Clearly, the "possible after an ASCII export" dropped somewhere in the
>> middle.
>
> New version of the patch attached.
>
> `:comments org' now produces by default plain text comments previously
> exported to ascii from org.

Thanks!
This change should be in ORG-NEWS.

> +(defun org-babel-export-comment-text-as-plain-text (comment)
> +  "Default function to process raw Org text collected to be
> +inserted as comments in tangled source-code files."
> +  (org-export-string-as comment 'ascii t))

Please document what the function does as the first line and document
the arguments. See D.6 Tips for Documentation Strings in Elisp manual.

The fact that this function is default for something is secondary for
the docstring. If you mention this fact, please also link back to the
defcustom.

> -                      (org-back-to-heading t) ; Sets match data
> -                      (match-end 0))
> +                      (re-search-backward org-heading-regexp) ; Sets match 
> data
> +                      (match-beginning 0))

This will err when the source block is before the first headline in the
document.

Best,
Ihor