summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarsten Dominik <carsten.dominik@gmail.com>2010-10-08 12:29:11 +0200
committerCarsten Dominik <carsten.dominik@gmail.com>2010-10-08 12:29:11 +0200
commit4a8b676d285853a567b201aaf249a6ef4ccdb227 (patch)
tree960fc7b685b270dcd2d3f4075c588734c6523a8f
parentaaab45081b7f9ce30b9c099eb0249d8efa9a4e28 (diff)
downloadorg-mode-4a8b676d285853a567b201aaf249a6ef4ccdb227.tar.gz
Document the `auto' setting of `org-blank-before-new-entry'.
* lisp/org.el (org-blank-before-new-entry): Improve docstring.
-rw-r--r--lisp/org.el10
1 files changed, 7 insertions, 3 deletions
diff --git a/lisp/org.el b/lisp/org.el
index f4c7a3e..a830971 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -1076,9 +1076,13 @@ for the duration of the command."
(plain-list-item . auto))
"Should `org-insert-heading' leave a blank line before new heading/item?
The value is an alist, with `heading' and `plain-list-item' as car,
-and a boolean flag as cdr. For plain lists, if the variable
-`org-empty-line-terminates-plain-lists' is set, the setting here
-is ignored and no empty line is inserted, to keep the list in tact."
+and a boolean flag as cdr. The cdr may lso be the symbol `auto', and then
+Org will look at the surrounding headings/items and try to make an
+intelligent decision wether to insert a blank line or not.
+
+For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
+set, the setting here is ignored and no empty line is inserted, to avoid
+breaking the list structure."
:group 'org-edit-structure
:type '(list
(cons (const heading)