branch: externals/org
commit c6849a2bc832cf07b2afdf9ba92b9ff3d3fc8558
Author: Ihor Radchenko <yanta...@posteo.net>
Commit: Ihor Radchenko <yanta...@posteo.net>
org-store-link-functions: Fix the docstring
* lisp/ol.el (org-store-link-functions): Describe the actual sequence
of calling store functions.
---
lisp/ol.el | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/lisp/ol.el b/lisp/ol.el
index 9968fc88a6..3d64b41b07 100644
--- a/lisp/ol.el
+++ b/lisp/ol.el
@@ -1118,12 +1118,12 @@ The functions are defined in the `:store' property of
INTERACTIVE? which indicates whether the user has initiated
`org-store-link' interactively.
-Each function will be called in turn until one returns a non-nil
-value. Each function should check if it is responsible for
-creating this link (for example by looking at the major mode).
-If not, it must exit and return nil. If yes, it should return
-a non-nil value after calling `org-link-store-props' with a list
-of properties and values. Special properties are:
+Each function will be called in turn with a single argument
+INTERACTIVE? - non-nil when user interaction is allowed. Each function
+should check if it is responsible for creating this link (for example
+by looking at the major mode). If not, it must return nil. If yes,
+it should return a non-nil value after calling `org-link-store-props'
+with a list of properties and values. Special properties are:
:type The link prefix, like \"http\". This must be given.
:link The link, like \"http://www.astro.uva.nl/~dominik\";.
