tec/org-mode
tec
/
org-mode
forked from mirrors/org-mode
1
0
Fork 0
Code Pull Requests Releases Activity

org-element: Fix docstrings

This commit is contained in:
Nicolas Goaziou 2012-01-19 19:14:13 +01:00
parent 3bace4b335
commit 95744ce7f8
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
contrib/lisp/org-element.el
View File

@ -3088,9 +3088,10 @@ Nil values returned from FUN are ignored in the result."
"Parse elements between BEG and END positions. "Parse elements between BEG and END positions.
SPECIAL prioritize some elements over the others. It can set to SPECIAL prioritize some elements over the others. It can set to
either `section' or `item', which will focus search, `quote-section', `section' or `item', which will focus search,
respectively, on sections and items. Moreover, when value is respectively, on quote sections, sections and items. Moreover,
`item', STRUCTURE will be used as the current list structure. when value is `item', STRUCTURE will be used as the current list
structure.
GRANULARITY determines the depth of the recursion. It can be set GRANULARITY determines the depth of the recursion. It can be set
to the following symbols: to the following symbols:
@ -3186,10 +3187,11 @@ element.
Possible types are defined in `org-element-all-elements'. Possible types are defined in `org-element-all-elements'.
Optional argument SPECIAL, when non-nil, can be either `item' or Optional argument SPECIAL, when non-nil, can be either `item',
`section'. The former allows to parse item wise instead of `section' or `quote-section'. `item' allows to parse item wise
plain-list wise, using STRUCTURE as the current list structure. instead of plain-list wise, using STRUCTURE as the current list
The latter will try to parse a section before anything else. structure. `section' (resp. `quote-section') will try to parse
a section (resp. a quote section) before anything else.
If STRUCTURE isn't provided but SPECIAL is set to `item', it will If STRUCTURE isn't provided but SPECIAL is set to `item', it will
be computed. be computed.