ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

lisp/ox-koma-letter.el: Fix checkdoc warnings 

* lisp/ox-koma-letter.el (org-koma-letter-use-foldmarks): Do not quote
t.
(org-koma-letter--special-contents-inline): Document INFO argument.
(org-koma-letter--add-latex-newlines): Mention STRING argument.
Clarify that the return value is a new string.
This commit is contained in:
Ihor Radchenko 2023-12-08 14:15:20 +01:00
parent 3b71939903
commit 3280f2f8bd
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
lisp/ox-koma-letter.el
View File

@ -374,7 +374,7 @@ following ones:
`p' Deactivate punch or center mark on left paper edge
`T' Activate lower horizontal mark on left paper edge
`t' Deactivate lower horizontal mark on left paper edge
t Deactivate lower horizontal mark on left paper edge
`V' Activate all vertical marks on upper paper edge
`v' Deactivate all vertical marks on upper paper edge
@ -571,6 +571,9 @@ return a string or nil."
KEYWORDS is a list of symbols. Return them as a string to be
formatted.
INFO is the information plist possibly holding :special-tags-as-macro
property. See `org-koma-letter-special-tags-as-macro'.
The function is used for inserting content of special headings
such as the one tagged with PS."
(mapconcat
@ -586,7 +589,8 @@ such as the one tagged with PS."
(defun org-koma-letter--add-latex-newlines (string)
"Replace regular newlines with LaTeX newlines (i.e. `\\\\')."
"Replace regular newlines with LaTeX newlines (i.e. `\\\\') in STRING.
Return a new string."
(let ((str (org-trim string)))
(when (org-string-nw-p str)
(replace-regexp-in-string "\n" "\\\\\\\\\n" str))))