From d68d8bc1f8d513f535b32383ef98f174b3573223 Mon Sep 17 00:00:00 2001 From: Nicolas Goaziou Date: Mon, 4 Oct 2021 00:00:33 +0200 Subject: [PATCH] oc: Pacify checkdoc * lisp/oc.el (org-cite-export-processors): (org-cite--move-punct-before): (org-cite-adjust-note): (org-cite--allowed-p): Add missing argument. --- lisp/oc.el | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/lisp/oc.el b/lisp/oc.el index ac8cafb96..17b577571 100644 --- a/lisp/oc.el +++ b/lisp/oc.el @@ -152,10 +152,10 @@ triplet following the pattern (NAME BIBLIOGRAPHY-STYLE CITATION-STYLE) There, NAME is the name of a registered citation processor providing export -functionality, as a symbol. BIBLIOGRAPHY-STYLE (resp. CITATION-STYLE) is the -desired default style to use when printing a bibliography (resp. exporting a -citation), as a string or nil. Both BIBLIOGRAPHY-STYLE and CITATION-STYLE are -optional. NAME is mandatory. +functionality, as a symbol. BIBLIOGRAPHY-STYLE (respectively CITATION-STYLE) +is the desired default style to use when printing a bibliography (respectively +exporting a citation), as a string or nil. Both BIBLIOGRAPHY-STYLE and +CITATION-STYLE are optional. NAME is mandatory. The export process selects the citation processor associated to the current export back-end, or the most specific back-end the current one is derived from, @@ -502,8 +502,8 @@ This function assumes S precedes CITATION." (defun org-cite--move-punct-before (punct citation s info) "Move punctuation PUNCT before CITATION object. -String S contains PUNCT. The function assumes S follows CITATION. -Parse tree is modified by side-effect." +String S contains PUNCT. INFO is the export state, as a property list. +The function assumes S follows CITATION. Parse tree is modified by side-effect." (if (equal s punct) (org-element-extract-element s) ;it would be empty anyway (org-element-set-element s (substring s (length punct)))) @@ -877,6 +877,9 @@ modified by side-effect." INFO is the export state, as a property list. +Optional argument RULE is the punctuation rule used, as a triplet. When nil, +rule is determined according to `org-cite-note-rules', which see. + Optional argument PUNCT is a list of punctuation marks to be considered. When nil, it defaults to `org-cite-punctuation-marks'. @@ -1386,7 +1389,8 @@ ARG is the prefix argument received when calling `org-open-at-point', or nil." ;;; Meta-command for citation insertion (insert capability) (defun org-cite--allowed-p (context) - "Non-nil when a citation can be inserted at point." + "Non-nil when a citation can be inserted at point. +CONTEXT is the element or object at point, as returned by `org-element-context'." (let ((type (org-element-type context))) (cond ;; No citation in attributes, except in parsed ones.