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

org-element: Fix docstring

Browse source 
* lisp/org-element.el (org-element--cache-objects): Fix docstring.
This commit is contained in:
Nicolas Goaziou 2014-03-27 10:47:36 +01:00
parent b5dd32c7e4
commit 3e5fc4540b
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
lisp/org-element.el
View file

@ -4621,12 +4621,12 @@ with `org-element--cache-compare'. This cache is used in
Key is an element, as returned by `org-element-at-point', and Key is an element, as returned by `org-element-at-point', and
value is an alist where each association is: value is an alist where each association is:
\(POS CANDIDATES . OBJECTS) \(POS COMPLETEP . OBJECTS)
where POS is a buffer position, CANDIDATES is the last know list where POS is a buffer position, COMPLETEP is a boolean non-nil
of successors (see `org-element--get-next-object-candidates') in when all objects at this level are already in cache and OBJECTS
container starting at POS and OBJECTS is a list of objects known is a list of objects known to live within that container, from
to live within that container, from farthest to closest. farthest to closest.
In the following example, \\alpha, bold object and \\beta start In the following example, \\alpha, bold object and \\beta start
at, respectively, positions 1, 7 and 8, at, respectively, positions 1, 7 and 8,
@ -4635,12 +4635,12 @@ at, respectively, positions 1, 7 and 8,
If the paragraph is completely parsed, OBJECTS-DATA will be If the paragraph is completely parsed, OBJECTS-DATA will be
\((1 nil BOLD-OBJECT ENTITY-OBJECT) \((1 t BOLD-OBJECT ENTITY-OBJECT)
\(8 nil ENTITY-OBJECT)) \(8 t ENTITY-OBJECT))
whereas in a partially parsed paragraph, it could be whereas in a partially parsed paragraph, it could be
\((1 ((entity . 1) (bold . 7)) ENTITY-OBJECT)) \((1 nil ENTITY-OBJECT))
This cache is used in `org-element-context'.") This cache is used in `org-element-context'.")