org-export: Improve a docstring

* contrib/lisp/org-export.el (org-export-get-genealogy): Improve
  docstring.
This commit is contained in:
Nicolas Goaziou 2012-07-10 15:30:51 +02:00
parent f88679a399
commit 9028c4655f
1 changed files with 5 additions and 1 deletions

View File

@ -3991,7 +3991,11 @@ BLOB is the element or object considered."
(defun org-export-get-genealogy (blob)
"Return full genealogy relative to a given element or object.
BLOB is the element or object being considered."
BLOB is the element or object being considered.
Ancestors are returned from closest to farthest, the last one
being the full parse tree."
(let (genealogy (parent blob))
(while (setq parent (org-element-property :parent parent))
(push parent genealogy))