mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-07-20 03:56:28 +00:00
org-store-link-functions: Fix the docstring
* lisp/ol.el (org-store-link-functions): Describe the actual sequence of calling store functions.
This commit is contained in:
parent
96b3129265
commit
c6849a2bc8
12
lisp/ol.el
12
lisp/ol.el
|
@ -1118,12 +1118,12 @@ The functions are defined in the `:store' property of
|
||||||
INTERACTIVE? which indicates whether the user has initiated
|
INTERACTIVE? which indicates whether the user has initiated
|
||||||
`org-store-link' interactively.
|
`org-store-link' interactively.
|
||||||
|
|
||||||
Each function will be called in turn until one returns a non-nil
|
Each function will be called in turn with a single argument
|
||||||
value. Each function should check if it is responsible for
|
INTERACTIVE? - non-nil when user interaction is allowed. Each function
|
||||||
creating this link (for example by looking at the major mode).
|
should check if it is responsible for creating this link (for example
|
||||||
If not, it must exit and return nil. If yes, it should return
|
by looking at the major mode). If not, it must return nil. If yes,
|
||||||
a non-nil value after calling `org-link-store-props' with a list
|
it should return a non-nil value after calling `org-link-store-props'
|
||||||
of properties and values. Special properties are:
|
with a list of properties and values. Special properties are:
|
||||||
|
|
||||||
:type The link prefix, like \"http\". This must be given.
|
:type The link prefix, like \"http\". This must be given.
|
||||||
:link The link, like \"http://www.astro.uva.nl/~dominik\".
|
:link The link, like \"http://www.astro.uva.nl/~dominik\".
|
||||||
|
|
Loading…
Reference in a new issue