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

Backport commit 6757f8e67 from Emacs 

* lisp/ob-core.el:
* lisp/ob-exp.el:
* lisp/ob-lob.el:
* lisp/ob-plantuml.el (org-babel-execute:plantuml):
* lisp/ob-python.el (org-babel-python--command)
(org-babel-python-initiate-session-by-key)
(org-babel-python-initiate-session):
* lisp/ob-scheme.el (org-babel-scheme-make-session-name):
* lisp/ob-tangle.el (org-babel-find-file-noselect-refresh)
(org-babel-interpret-file-mode):
* lisp/ob.el:
* lisp/org-agenda.el (org-agenda-mouse-1-follows-link)
(org-agenda-start-with-archives-mode)
(org-agenda-previous-line):
* lisp/org-clock.el (org-clock-save, org-clock-load):
* lisp/org-element-ast.el (org-element-type-p):
* lisp/org-faces.el (org-cycle-level-faces):
* lisp/org-fold-core.el (org-fold-core--isearch-overlays):
* lisp/org-fold.el (org-fold--extend-changed-region):
* lisp/org-goto.el:
* lisp/org-habit.el (org-habit-show-all-today):
* lisp/org-inlinetask.el (org-inlinetask-in-task-p):
* lisp/org-macs.el (org-current-text-column):
* lisp/org-mobile.el (org-mobile-check-setup):
* lisp/org-mouse.el (org-mouse-bolp):
* lisp/org-refile.el (org-refile):
* lisp/org-src.el (org-src-do-key-sequence-at-code-block):
* lisp/org-table.el (orgtbl-after-send-table-hook)
(orgtbl-self-insert-command, orgtbl-to-orgtbl):
* lisp/org.el (org-read-date-popup-calendar, org-finish-function)
(org-occur-parameters, org-self-insert-command, org-ctrl-c-ctrl-c-hook)
(org-ctrl-c-ctrl-c-final-hook, org-submit-bug-report)
(org--single-lines-list-is-paragraph):
* lisp/ox-icalendar.el (org-icalendar--vtodo):
* lisp/ox-latex.el (org-latex-generate-engraved-preamble):
(org-latex-src--engrave-code):
* lisp/ox-publish.el (org-publish-project-alist):
* lisp/ox.el (org-export-data): Various checkdoc fixes.

Checkdoc fixes in Org Mode
6757f8e67d3bdfe338810fc26408a62e7839afe7
Stefan Kangas
Sun Jul 7 17:46:25 2024 +0200
This commit is contained in:
Stefan Kangas 2024-07-07 14:27:14 +02:00 committed by Kyle Meyer
parent 5ec1ec3337
commit e14969f629
28 changed files with 62 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lisp/ob-core.el
View File

@ -22,6 +22,8 @@
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'org-macs)

2
lisp/ob-exp.el
View File

@ -22,6 +22,8 @@
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'org-macs)

2
lisp/ob-lob.el
View File

@ -22,6 +22,8 @@
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'org-macs)

2
lisp/ob-plantuml.el
View File

@ -116,7 +116,7 @@ This function is called by `org-babel-execute-src-block'."
(let* ((do-export (member "file" (cdr (assq :result-params params))))
(out-file (if do-export
(or (cdr (assq :file params))
(error "No :file provided but :results set to file. For plain text output, set :results to verbatim"))
(error "No :file provided but :results set to file. For plain text output, set :results to verbatim"))
(org-babel-temp-file "plantuml-" ".txt")))
(cmdline (cdr (assq :cmdline params)))
(in-file (org-babel-temp-file "plantuml-"))

6
lisp/ob-python.el
View File

@ -279,7 +279,7 @@ be removed after minimum supported version reaches emacs29."
This checks `org-babel-python-command', and then
`org-babel-python-command-session' (if IS-SESSION) or
`org-babel-python-command-nonsession' (if not IS-SESSION). If
IS-SESSION, this might return `nil', which means to use
IS-SESSION, this might return nil, which means to use
`python-shell-calculate-command'."
(or (unless (eq org-babel-python-command 'auto)
org-babel-python-command)
@ -300,7 +300,7 @@ unless the Python session was created outside Org."
(defun org-babel-python-initiate-session-by-key (&optional session)
"Initiate a python session.
If there is not a current inferior-process-buffer matching
SESSION then create it. If inferior process already
SESSION then create it. If inferior process already
exists (e.g. if it was manually started with `run-python'), make
sure it's configured to work with ob-python. If session has
already been configured as such, do nothing. Return the
@ -356,7 +356,7 @@ initialized session."
(defun org-babel-python-initiate-session (&optional session _params)
"Initiate Python session named SESSION according to PARAMS.
If there is not a current inferior-process-buffer matching
SESSION then create it. If inferior process already
SESSION then create it. If inferior process already
exists (e.g. if it was manually started with `run-python'), make
sure it's configured to work with ob-python. If session has
already been configured as such, do nothing."

4
lisp/ob-scheme.el
View File

@ -143,14 +143,14 @@ If the variables HOST and PORT are set, connect to the running Scheme REPL."
(current-buffer)))))
(defun org-babel-scheme-make-session-name (buffer name impl)
"Generate a name for the session buffer.
"Generate a NAME for the session BUFFER.
For a named session, the buffer name will be the session name.
If the session is unnamed (nil), generate a name.
If the session is `none', use nil for the session name, and
org-babel-scheme-execute-with-geiser will use a temporary session."
`org-babel-scheme-execute-with-geiser' will use a temporary session."
(cond ((not name) (concat buffer " " (symbol-name impl) " REPL"))
((string= name "none") nil)
(name)))

9
lisp/ob-tangle.el
View File

@ -184,8 +184,7 @@ replace contents otherwise."
:safe t)
(defun org-babel-find-file-noselect-refresh (file)
"Find file ensuring that the latest changes on disk are
represented in the file."
"Find file ensuring that the latest changes on disk are represented in the file."
(find-file-noselect file 'nowarn)
(with-current-buffer (get-file-buffer file)
(revert-buffer t t t)))
@ -386,10 +385,10 @@ The following forms are currently recognized:
((integerp mode)
(if (string-match-p "^[0-7][0-7][0-7]$" (format "%o" mode))
mode
(user-error "%1$o is not a valid file mode octal. \
(user-error "%1$o is not a valid file mode octal. \
Did you give the decimal value %1$d by mistake?" mode)))
((not (stringp mode))
(error "File mode %S not recognized as a valid format." mode))
(error "File mode %S not recognized as a valid format" mode))
((string-match-p "^o0?[0-7][0-7][0-7]$" mode)
(string-to-number (replace-regexp-in-string "^o" "" mode) 8))
((string-match-p "^[ugoa]*\\(?:[+=-][rwxXstugo]*\\)+\\(,[ugoa]*\\(?:[+=-][rwxXstugo]*\\)+\\)*$" mode)
@ -400,7 +399,7 @@ Did you give the decimal value %1$d by mistake?" mode)))
",g=" (delete ?- (substring mode 3 6))
",o=" (delete ?- (substring mode 6 9)))
0))
(t (error "File mode %S not recognized as a valid format. See `org-babel-interpret-file-mode'." mode))))
(t (error "File mode %S not recognized as a valid format. See `org-babel-interpret-file-mode'" mode))))
(defun org-babel-tangle-clean ()
"Remove comments inserted by `org-babel-tangle'.

2
lisp/ob.el
View File

@ -21,6 +21,8 @@
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'org-macs)

6
lisp/org-agenda.el
View File

@ -1041,7 +1041,7 @@ headlines as the agenda display heavily relies on them."
:type 'hook)
(defcustom org-agenda-mouse-1-follows-link nil
"Non-nil means mouse-1 on a link will follow the link in the agenda.
"Non-nil means \\`mouse-1' on a link will follow the link in the agenda.
A longer mouse click will still set point. Needs to be set
before org.el is loaded."
:group 'org-agenda-startup
@ -1100,7 +1100,7 @@ removed from entry text before it is shown in the agenda."
:type 'string)
(defcustom org-agenda-start-with-archives-mode nil
"Initial value of archive-mode in a newly created agenda window.
"Initial value of archive mode in a newly created agenda window.
See `org-agenda-archives-mode' for acceptable values and their
meaning."
:group 'org-agenda-startup
@ -9190,7 +9190,7 @@ When called with a prefix argument, include all archive files as well."
(org-agenda-do-context-action))
(defun org-agenda-previous-line ()
"Move cursor to the previous line, and show if follow-mode is active."
"Move cursor to the previous line, and show if follow mode is active."
(interactive)
(call-interactively 'previous-line)
(org-agenda-do-context-action))

4
lisp/org-clock.el
View File

@ -3261,7 +3261,7 @@ The details of what will be saved are regulated by the variable
(and (buffer-live-p b)
(buffer-file-name b)
(or (not org-clock-persist-query-save)
(y-or-n-p (format "Save current clock (%s) "
(y-or-n-p (format "Save current clock (%s)?"
org-clock-heading))))))
(insert
(format "(setq org-clock-stored-resume-clock '(%S . %d))\n"
@ -3301,7 +3301,7 @@ The details of what will be saved are regulated by the variable
(`(,(and file (pred file-exists-p)) . ,position)
(with-current-buffer (find-file-noselect file)
(when (or (not org-clock-persist-query-resume)
(y-or-n-p (format "Resume clock (%s) "
(y-or-n-p (format "Resume clock (%s)?"
(save-excursion
(goto-char position)
(org-get-heading t t)))))

2
lisp/org-element-ast.el
View File

@ -231,7 +231,7 @@ when NODE is an anonymous node."
(define-inline org-element-type-p (node types)
"Return non-nil when NODE type is one of TYPES.
TYPES can be a type symbol or a list of symbols."
TYPES can be a type symbol or a list of symbols."
(inline-letevals (node types)
(if (listp (inline-const-val types))
(inline-quote (memq (org-element-type ,node t) ,types))

4
lisp/org-faces.el
View File

@ -690,8 +690,8 @@ If it is less than 8, the level-1 face gets reused for level N+1 etc."
(defcustom org-cycle-level-faces t
"Non-nil means level styles cycle after level `org-n-level-faces'.
Then so level org-n-level-faces+1 is styled like level 1.
If nil, then all levels >= org-n-level-faces are styled like
level org-n-level-faces."
If nil, then all levels >= `org-n-level-faces' are styled like
level `org-n-level-faces'."
:group 'org-appearance
:group 'org-faces
:version "24.1"

4
lisp/org-fold-core.el
View File

@ -160,7 +160,7 @@
;; If one wants to search invisible text without using the provided
;; functions, it is important to keep in mind that 'invisible text
;; property may have multiple possible values (not just nil and
;; t). Hence, (next-single-char-property-change pos 'invisible) is not
;; t). Hence, (next-single-char-property-change pos 'invisible) is not
;; guaranteed to return the boundary of invisible/visible text.
;;; Interactive searching inside folded text (via isearch)
@ -1172,7 +1172,7 @@ because otherwise all these markers will point to nowhere."
This is used to allow searching in regions hidden via text properties.
As for [2020-05-09 Sat], Isearch only has special handling of hidden overlays.
Any text hidden via text properties is not revealed even if `search-invisible'
is set to `t'.")
is set to t.")
(defvar-local org-fold-core--isearch-local-regions (make-hash-table :test 'equal)
"Hash table storing temporarily shown folds from isearch matches.")

3
lisp/org-fold.el
View File

@ -733,8 +733,7 @@ go to the parent and show the entire tree."
;;; Handling changes in folded elements
(defun org-fold--extend-changed-region (from to)
"Consider folded regions in the next/previous line when fixing
region visibility.
"Consider folded regions in the next/previous line when fixing region visibility.
This function is intended to be used as a member of
`org-fold-core-extend-changed-region-functions'."
;; If the edit is done in the first line of a folded drawer/block,

2
lisp/org-goto.el
View File

@ -20,6 +20,8 @@
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'org-macs)

2
lisp/org-habit.el
View File

@ -69,7 +69,7 @@ relative to the current effective date."
:type 'boolean)
(defcustom org-habit-show-all-today nil
"If non-nil, will show the consistency graph of all habits on
"If non-nil, show the consistency graph of all habits on
today's agenda, even if they are not scheduled."
:group 'org-habit
:type 'boolean)

2
lisp/org-inlinetask.el
View File

@ -172,7 +172,7 @@ The number of levels is controlled by `org-inlinetask-min-level'."
(not (org-inlinetask-end-p))))
(defun org-inlinetask-in-task-p ()
"Return true if point is inside an inline task."
"Return non-nil if point is inside an inline task."
(save-excursion
(forward-line 0)
(let ((case-fold-search t))

2
lisp/org-macs.el
View File

@ -1228,7 +1228,7 @@ This function forces `tab-width' value because it is used as a part of
the parser, to ensure parser consistency when calculating list
indentation."
`(progn
(unless (= 8 tab-width) (error "Tab width in Org files must be 8, not %d. Please adjust your `tab-width' settings for Org mode." tab-width))
(unless (= 8 tab-width) (error "Tab width in Org files must be 8, not %d. Please adjust your `tab-width' settings for Org mode" tab-width))
(string-width (buffer-substring-no-properties
(line-beginning-position) (point)))))

2
lisp/org-mobile.el
View File

@ -392,7 +392,7 @@ agenda view showing the flagged items."
(org-agenda nil "?"))))))
(defun org-mobile-check-setup ()
"Check if org-mobile-directory has been set up."
"Check if `org-mobile-directory' has been set up."
(org-mobile-cleanup-encryption-tempfile)
(unless (and org-directory
(stringp org-directory)

2
lisp/org-mouse.el
View File

@ -561,7 +561,7 @@ SCHEDULED: or DEADLINE: or ANYTHINGLIKETHIS:"
(save-excursion (org-apply-on-list wrap-fun nil)))))
(defun org-mouse-bolp ()
"Return true if there only spaces, tabs, and `*' before point.
"Return non-nil if there only spaces, tabs, and `*' before point.
This means, between the beginning of line and the point."
(save-excursion
(skip-chars-backward " \t*") (bolp)))

4
lisp/org-refile.el
View File

@ -470,8 +470,8 @@ See also `org-refile-use-outline-path'.
If you are using target caching (see `org-refile-use-cache'), you
have to clear the target cache in order to find new targets.
This can be done with a `0' prefix (`C-0 C-c C-w') or a triple
prefix argument (`C-u C-u C-u C-c C-w')."
This can be done with a `0' prefix (\\`C-0 C-c C-w') or a triple
prefix argument (\\`C-u C-u C-u C-c C-w')."
(interactive "P")
(if (member arg '(0 (64)))
(org-refile-cache-clear)

8
lisp/org-src.el
View File

@ -950,16 +950,16 @@ remotely with point temporarily at the start of the code block in
the Org buffer.
This command is not bound to a key by default, to avoid conflicts
with language major mode bindings. To bind it to C-c @ in all
with language major mode bindings. To bind it to \\`C-c @' in all
language major modes, you could use
(add-hook \\='org-src-mode-hook
(lambda () (define-key org-src-mode-map \"\\C-c@\"
\\='org-src-do-key-sequence-at-code-block)))
In that case, for example, C-c @ t issued in code edit buffers
would tangle the current Org code block, C-c @ e would execute
the block and C-c @ h would display the other available
In that case, for example, \\`C-c @ t' issued in code edit buffers
would tangle the current Org code block, \\`C-c @ e' would execute
the block and \\`C-c @ h' would display the other available
Org-babel commands."
(interactive "kOrg-babel key: ")
(if (equal key (kbd "C-g")) (keyboard-quit)

6
lisp/org-table.el
View File

@ -622,7 +622,7 @@ This variable is set by `org-before-change-function'.
`org-table-align' sets it back to nil.")
(defvar orgtbl-after-send-table-hook nil
"Hook for functions attaching to `C-c C-c', if the table is sent.
"Hook for functions attaching to \\`C-c C-c', if the table is sent.
This can be used to add additional functionality after the table is sent
to the receiver position, otherwise, if table is not sent, the functions
are not run.")
@ -5423,7 +5423,7 @@ conflicting binding to this key outside `orgtbl-mode'."
(org-table-next-row)))
(defun orgtbl-self-insert-command (N)
"Like `self-insert-command', use overwrite-mode for whitespace in tables.
"Like `self-insert-command', use `overwrite-mode' for whitespace in tables.
If the cursor is in a table looking at whitespace, the whitespace is
overwritten, and the table is not marked as requiring realignment."
(interactive "p")
@ -6156,7 +6156,7 @@ supported. It is also possible to use the following one:
;;;###autoload
(defun orgtbl-to-orgtbl (table params)
"Convert the `orgtbl-mode' TABLE into another orgtbl-mode table.
"Convert the `orgtbl-mode' TABLE into another `orgtbl-mode' table.
TABLE is a list, each entry either the symbol `hline' for
a horizontal separator line, or a list of fields for that line.

20
lisp/org.el
View File

@ -2670,7 +2670,7 @@ is non-nil."
(defcustom org-read-date-popup-calendar t
"Non-nil means pop up a calendar when prompting for a date.
In the calendar, the date can be selected with mouse-1. However, the
In the calendar, the date can be selected with \\`mouse-1'. However, the
minibuffer will also be active, and you can simply enter the date as well.
When nil, only the minibuffer will be available."
:group 'org-time
@ -4855,7 +4855,7 @@ Respect keys that are already there."
(defvar org-selected-window nil
"Used in various places to store a window configuration.")
(defvar org-finish-function nil
"Function to be called when `C-c C-c' is used.
"Function to be called when \\`C-c C-c' is used.
This is for getting out of special buffers like capture.")
(defvar org-last-state)
@ -11008,7 +11008,7 @@ containing the regular expression and the callback, onto the list.
The list can contain several entries if `org-occur' has been called
several time with the KEEP-PREVIOUS argument. Otherwise, this list
will only contain one set of parameters. When the highlights are
removed (for example with `C-c C-c', or with the next edit (depending
removed (for example with \\`C-c C-c', or with the next edit (depending
on `org-remove-highlights-with-change'), this variable is emptied
as well.")
@ -17087,7 +17087,7 @@ Set `org-speed-command' to the appropriate command as a side effect."
(make-string 1 (aref kv (1- (length kv)))))))))
(defun org-self-insert-command (N)
"Like `self-insert-command', use overwrite-mode for whitespace in tables.
"Like `self-insert-command', use `overwrite-mode' for whitespace in tables.
If the cursor is in a table looking at whitespace, the whitespace is
overwritten, and the table is not marked as requiring realignment."
(interactive "p")
@ -17236,9 +17236,9 @@ word constituents."
(call-interactively 'transpose-words)))
(defvar org-ctrl-c-ctrl-c-hook nil
"Hook for functions attaching themselves to `C-c C-c'.
"Hook for functions attaching themselves to \\`C-c C-c'.
This can be used to add additional functionality to the `C-c C-c'
This can be used to add additional functionality to the \\`C-c C-c'
key which executes context-dependent commands. This hook is run
before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
run after the last test.
@ -17249,9 +17249,9 @@ it should do its thing and then return a non-nil value. If the
context is wrong, just do nothing and return nil.")
(defvar org-ctrl-c-ctrl-c-final-hook nil
"Hook for functions attaching themselves to `C-c C-c'.
"Hook for functions attaching themselves to \\`C-c C-c'.
This can be used to add additional functionality to the `C-c C-c'
This can be used to add additional functionality to the \\`C-c C-c'
key which executes context-dependent commands. This hook is run
after any other test, while `org-ctrl-c-ctrl-c-hook' is run
before the first test.
@ -19065,7 +19065,7 @@ appear in the form of file names, tags, todo states or search strings.
If you answer \"yes\" to the prompt, you might want to check and remove
such private information before sending the email.")
(add-text-properties (point-min) (point-max) '(face org-warning))
(when (yes-or-no-p "Include your Org configuration and Org warning log ")
(when (yes-or-no-p "Include your Org configuration and Org warning log?")
(mapatoms
(lambda (v)
(and (boundp v)
@ -21803,7 +21803,7 @@ It also provides the following special moves for convenience:
arg))
(defvar org--single-lines-list-is-paragraph t
"Treat plain lists with single line items as a whole paragraph")
"Treat plain lists with single line items as a whole paragraph.")
(defun org--paragraph-at-point ()
"Return paragraph, or equivalent, element at point.

4
lisp/ox-icalendar.el
View File

@ -932,14 +932,14 @@ Return VTODO component as a string."
:repeater-unit dl)))))
;; TODO Implement via RDATE with changing DURATION
(org-display-warning "Not yet implemented: \
different repeaters on SCHEDULED and DEADLINE. Skipping.")
different repeaters on SCHEDULED and DEADLINE. Skipping.")
nil)
;; DEADLINE has repeater but SCHEDULED doesn't
((and dl-repeat-p (and sc (not sc-repeat-p)))
;; TODO SCHEDULED should only apply to first instance;
;; use RDATE with custom DURATION to implement that
(org-display-warning "Not yet implemented: \
repeater on DEADLINE but not SCHEDULED. Skipping.")
repeater on DEADLINE but not SCHEDULED. Skipping.")
nil)
((or sc-repeat-p dl-repeat-p)
(concat

6
lisp/ox-latex.el
View File

@ -1391,7 +1391,7 @@ default values of which are given by `org-latex-engraved-preamble' and
"\n"))
(t (funcall gen-theme-spec engraved-theme))))
(funcall gen-theme-spec engraved-theme))
(warn "Cannot engrave source blocks. Consider installing `engrave-faces'.")
(warn "Cannot engrave source blocks. Consider installing `engrave-faces'.")
"% WARNING syntax highlighting unavailable as engrave-faces-latex was missing.\n")
"\n")))
@ -3548,7 +3548,7 @@ and FLOAT are extracted from SRC-BLOCK and INFO in `org-latex-src-block'."
When the THEME symbol is non-nil, that theme will be used.
When INLINE is nil, a Verbatim environment wrapped in a Code
environment will be used. When t, a Verb command will be used.
environment will be used. When t, a Verb command will be used.
When OPTIONS is provided, as either a string or list of key-value
pairs accepted by `org-latex--make-option-string', it is passed
@ -3591,7 +3591,7 @@ to the Verbatim environment or Verb command."
engraved-wrapped
"}")
engraved-wrapped))
(user-error "Cannot engrave code as `engrave-faces-latex' is unavailable.")))
(user-error "Cannot engrave code as `engrave-faces-latex' is unavailable")))
(cl-defun org-latex-src-block--engraved
(&key src-block info lang caption caption-above-p num-start retain-labels attributes float &allow-other-keys)

2
lisp/ox-publish.el
View File

@ -88,7 +88,7 @@ cdr of each element is in one of the following forms:
(:components (\"project-1\" \"project-2\" ...))
When the CDR of an element of org-publish-project-alist is in
When the CDR of an element of `org-publish-project-alist' is in
this second form, the elements of the list after `:components'
are taken to be components of the project, which group together
files requiring different publishing options. When you publish

2
lisp/ox.el
View File

@ -1931,7 +1931,7 @@ Return a string."
(progn ,@body)
(org-link-broken
(pcase (plist-get info :with-broken-links)
(`nil (user-error "Org export aborted. Unable to resolve link: %S\nSee `org-export-with-broken-links'." (nth 1 err)))
(`nil (user-error "Org export aborted. Unable to resolve link: %S\nSee `org-export-with-broken-links'" (nth 1 err)))
(`mark (org-export-data
(format "[BROKEN LINK: %s]" (nth 1 err)) info))
(_ nil))))))