mirrors
/
org-mode
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git
0
0
Fork 1
Code Releases Activity

oc: Fix docstring typos 

* lisp/oc.el (org-cite-make-insert-processor): Fix typos in docstring.
Fill mostly under 60 characters.
This commit is contained in:
Nicolas Goaziou 2021-11-10 11:47:22 +01:00
parent 876e813334
commit e961125768
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
lisp/oc.el
View File

@ -1523,38 +1523,42 @@ Citation keys are strings without the leading \"@\"."
(defun org-cite-make-insert-processor (select-key select-style) (defun org-cite-make-insert-processor (select-key select-style)
"Build a function appropriate as an insert processor. "Build a function appropriate as an insert processor.
SELECT-KEY is a function called with one argument. When it is nil, the function SELECT-KEY is a function called with one argument. When it is
should return a citation key as a string, or nil. Otherwise, the function nil, the function should return a citation key as a string, or
should return a list of such keys, or nil. The keys should not have any leading nil. Otherwise, the function should return a list of such keys,
\"@\" character. or nil. The keys should not have any leading \"@\" character.
SELECT-STYLE is a function called with one argument, the citation object being SELECT-STYLE is a function called with one argument, the citation
edited or constructed so far. It should return a style string, or nil. object being edited or constructed so far. It should return
a style string, or nil.
The return value is a function of two arguments: CONTEXT and ARG. CONTEXT is The return value is a function of two arguments: CONTEXT and ARG.
either a citation reference, a citation object, or nil. ARG is a prefix CONTEXT is either a citation reference, a citation object, or
argument. nil. ARG is a prefix argument.
The generated function inserts or edit a citation at point. More specifically, The generated function inserts or edits a citation at point.
More specifically,
On a citation reference: On a citation reference:
- on the prefix or right before th \"@\" character, insert a new reference - on the prefix or right before th \"@\" character, insert
before the current one, a new reference before the current one,
- on the suffix, insert it after the reference, - on the suffix, insert it after the reference,
- otherwise, update the cite key, preserving both affixes. - otherwise, update the cite key, preserving both affixes.
When ARG is non-nil, remove the reference, possibly removing the whole When ARG is non-nil, remove the reference, possibly removing
citation if it contains a single reference. the whole citation if it contains a single reference.
On a citation object: On a citation object:
- on the style part, offer to update it, - on the style part, offer to update it,
- on the global prefix, add a new reference before the first one, - on the global prefix, add a new reference before the first
- on the global suffix, add a new reference after the last one, one,
- on the global suffix, add a new reference after the last
one.
Elsewhere, insert a citation at point. When ARG is non-nil, offer to complete Elsewhere, insert a citation at point. When ARG is non-nil,
style in addition to references." offer to complete style in addition to references."
(unless (and (functionp select-key) (functionp select-style)) (unless (and (functionp select-key) (functionp select-style))
(error "Wrong argument type(s)")) (error "Wrong argument type(s)"))
(lambda (context arg) (lambda (context arg)