0
0
Fork 1
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-09-29 19:37:52 +00:00

org: Remove useless example in docstring

* lisp/org.el (org-find-olp): Remove useless example in docstring.

TINYCHANGE
This commit is contained in:
Leo Vivier 2020-07-20 22:11:15 +02:00 committed by Kyle Meyer
parent b2b587387e
commit c9abb4c29a

View file

@ -13930,15 +13930,9 @@ completion."
(defun org-find-olp (path &optional this-buffer)
"Return a marker pointing to the entry at outline path OLP.
If anything goes wrong, throw an error.
You can wrap this call to catch the error like this:
(condition-case msg
(org-mobile-locate-entry (match-string 4))
(error (nth 1 msg)))
The return value will then be either a string with the error message,
or a marker if everything is OK.
If anything goes wrong, throw an error, and if you need to do
something based on this error, you can catch it with
`condition-case'.
If THIS-BUFFER is set, the outline path does not contain a file,
only headings."