org-id.el (org-id-get-with-outline-path-completion): Fix docstring

* org-id.el (org-id-get-with-outline-path-completion): Fix
docstring.

Thanks to Florian Beck for reporting this.
This commit is contained in:
Bastien Guerry 2013-02-07 08:42:15 +01:00
parent b07a9bb29a
commit fa55168d26
1 changed files with 5 additions and 5 deletions

View File

@ -259,11 +259,11 @@ In any case, the ID of the entry is returned."
id)))))
(defun org-id-get-with-outline-path-completion (&optional targets)
"Use outline-path-completion to retrieve the ID of an entry.
TARGETS may be a setting for `org-refile-targets' to define the eligible
headlines. When omitted, all headlines in all agenda files are
eligible.
It returns the ID of the entry. If necessary, the ID is created."
"Use `outline-path-completion' to retrieve the ID of an entry.
TARGETS may be a setting for `org-refile-targets' to define
eligible headlines. When omitted, all headlines in the current
file are eligible. This function returns the ID of the entry.
If necessary, the ID is created."
(let* ((org-refile-targets (or targets '((nil . (:maxlevel . 10)))))
(org-refile-use-outline-path
(if (caar org-refile-targets) 'file t))