Browse Source

Improve a docstring

* lisp/org.el (org-delete-all): Improve docstring.
Nicolas Goaziou 8 years ago
parent
commit
0d72c34937
1 changed files with 3 additions and 1 deletions
  1. 3 1
      lisp/org.el

+ 3 - 1
lisp/org.el

@@ -22720,7 +22720,9 @@ The function returns the new ALIST."
     rtn))
 
 (defun org-delete-all (elts list)
-  "Remove all elements in ELTS from LIST."
+  "Remove all elements in ELTS from LIST.
+Comparison is done with `equal'.  It is a destructive operation
+that may remove elements by altering the list structure."
   (while elts
     (setq list (delete (pop elts) list)))
   list)