org-list.el (org-cycle-include-plain-lists): Docstring enhancement

* org-list.el (org-cycle-include-plain-lists): Docstring
enhancement.

Thanks to James Harkins for raising this issue.
This commit is contained in:
Bastien Guerry 2013-01-01 16:31:26 +01:00
parent 98cd4687a2
commit f1067fb47c
1 changed files with 9 additions and 9 deletions

View File

@ -144,15 +144,15 @@ item. When the cursor is on an outline heading, plain lists are
treated as text. This is the most stable way of handling this,
which is why it is the default.
When this is the symbol `integrate', then during cycling, plain
list items will *temporarily* be interpreted as outline headlines
with a level given by 1000+i where i is the indentation of the
bullet. This setting can lead to strange effects when switching
visibility to `children', because the first \"child\" in a
subtree decides what children should be listed. If that first
\"child\" is a plain list item with an implied large level
number, all true children and grand children of the outline
heading will be exposed in a children' view."
When this is the symbol `integrate', then integrate plain list
items when cycling, as if they were children of outline headings.
This setting can lead to strange effects when switching visibility
to `children', because the first \"child\" in a subtree decides
what children should be listed. If that first \"child\" is a
plain list item with an implied large level number, all true
children and grand children of the outline heading will be
exposed in a children' view."
:group 'org-plain-lists
:type '(choice
(const :tag "Never" nil)