Backport commit 41ba8231e from Emacs

* lisp/ob-scheme.el (org-babel-scheme-get-buffer-impl):
* lisp/ob-shell.el (org-babel--variable-assignments:sh-generic)
(org-babel--variable-assignments:bash_array)
(org-babel--variable-assignments:bash_assoc)
(org-babel--variable-assignments:bash):
* lisp/org-clock.el (org-day-of-week):
(table--put-cell-valign-property): Fix typos.
* lisp/ob-core.el (org-babel-named-src-block-regexp-for-name)
(org-babel-named-data-regexp-for-name): Doc fix.
(org-babel-src-block-names, org-babel-result-names): Fix typos.

lisp/*.el: Fix typos and improve some docstrings
41ba8231ef072571e1a6feabc15d113e5cf57556
Juanma Barranquero
Sun Oct 20 12:12:27 2019 +0200
This commit is contained in:
Juanma Barranquero 2019-10-20 12:12:27 +02:00 committed by Kyle Meyer
parent e3090573be
commit 9c611fd8ac
5 changed files with 11 additions and 11 deletions

View File

@ -526,7 +526,7 @@ to raise errors for all languages.")
"Hook for functions to be called after `org-babel-execute-src-block'") "Hook for functions to be called after `org-babel-execute-src-block'")
(defun org-babel-named-src-block-regexp-for-name (&optional name) (defun org-babel-named-src-block-regexp-for-name (&optional name)
"This generates a regexp used to match a source block named NAME. "Generate a regexp used to match a source block named NAME.
If NAME is nil, match any name. Matched name is then put in If NAME is nil, match any name. Matched name is then put in
match group 9. Other match groups are defined in match group 9. Other match groups are defined in
`org-babel-src-block-regexp'." `org-babel-src-block-regexp'."
@ -537,7 +537,7 @@ match group 9. Other match groups are defined in
(substring org-babel-src-block-regexp 1))) (substring org-babel-src-block-regexp 1)))
(defun org-babel-named-data-regexp-for-name (name) (defun org-babel-named-data-regexp-for-name (name)
"This generates a regexp used to match data named NAME." "Generate a regexp used to match data named NAME."
(concat org-babel-name-regexp (regexp-quote name) "[ \t]*$")) (concat org-babel-name-regexp (regexp-quote name) "[ \t]*$"))
(defun org-babel--normalize-body (datum) (defun org-babel--normalize-body (datum)
@ -1789,7 +1789,7 @@ to `org-babel-named-src-block-regexp'."
(ignore-errors (org-next-block 1 nil regexp)))))) (ignore-errors (org-next-block 1 nil regexp))))))
(defun org-babel-src-block-names (&optional file) (defun org-babel-src-block-names (&optional file)
"Returns the names of source blocks in FILE or the current buffer." "Return the names of source blocks in FILE or the current buffer."
(with-current-buffer (if file (find-file-noselect file) (current-buffer)) (with-current-buffer (if file (find-file-noselect file) (current-buffer))
(org-with-point-at 1 (org-with-point-at 1
(let ((regexp "^[ \t]*#\\+begin_src ") (let ((regexp "^[ \t]*#\\+begin_src ")
@ -1834,7 +1834,7 @@ buffer or nil if no such result exists."
(throw :found (line-beginning-position))))))))) (throw :found (line-beginning-position)))))))))
(defun org-babel-result-names (&optional file) (defun org-babel-result-names (&optional file)
"Returns the names of results in FILE or the current buffer." "Return the names of results in FILE or the current buffer."
(save-excursion (save-excursion
(when file (find-file file)) (goto-char (point-min)) (when file (find-file file)) (goto-char (point-min))
(let ((case-fold-search t) names) (let ((case-fold-search t) names)

View File

@ -102,7 +102,7 @@
(puthash session-name buffer org-babel-scheme-repl-map)) (puthash session-name buffer org-babel-scheme-repl-map))
(defun org-babel-scheme-get-buffer-impl (buffer) (defun org-babel-scheme-get-buffer-impl (buffer)
"Returns the scheme implementation geiser associates with the buffer." "Return the scheme implementation geiser associates with the buffer."
(with-current-buffer (set-buffer buffer) (with-current-buffer (set-buffer buffer)
geiser-impl--implementation)) geiser-impl--implementation))

View File

@ -112,12 +112,12 @@ This function is called by `org-babel-execute-src-block'."
;;; Helper functions ;;; Helper functions
(defun org-babel--variable-assignments:sh-generic (defun org-babel--variable-assignments:sh-generic
(varname values &optional sep hline) (varname values &optional sep hline)
"Returns a list of statements declaring the values as a generic variable." "Return a list of statements declaring the values as a generic variable."
(format "%s=%s" varname (org-babel-sh-var-to-sh values sep hline))) (format "%s=%s" varname (org-babel-sh-var-to-sh values sep hline)))
(defun org-babel--variable-assignments:bash_array (defun org-babel--variable-assignments:bash_array
(varname values &optional sep hline) (varname values &optional sep hline)
"Returns a list of statements declaring the values as a bash array." "Return a list of statements declaring the values as a bash array."
(format "unset %s\ndeclare -a %s=( %s )" (format "unset %s\ndeclare -a %s=( %s )"
varname varname varname varname
(mapconcat (mapconcat
@ -127,7 +127,7 @@ This function is called by `org-babel-execute-src-block'."
(defun org-babel--variable-assignments:bash_assoc (defun org-babel--variable-assignments:bash_assoc
(varname values &optional sep hline) (varname values &optional sep hline)
"Returns a list of statements declaring the values as bash associative array." "Return a list of statements declaring the values as bash associative array."
(format "unset %s\ndeclare -A %s\n%s" (format "unset %s\ndeclare -A %s\n%s"
varname varname varname varname
(mapconcat (mapconcat
@ -140,7 +140,7 @@ This function is called by `org-babel-execute-src-block'."
"\n"))) "\n")))
(defun org-babel--variable-assignments:bash (varname values &optional sep hline) (defun org-babel--variable-assignments:bash (varname values &optional sep hline)
"Represents the parameters as useful Bash shell variables." "Represent the parameters as useful Bash shell variables."
(pcase values (pcase values
(`((,_ ,_ . ,_) . ,_) ;two-dimensional array (`((,_ ,_ . ,_) . ,_) ;two-dimensional array
(org-babel--variable-assignments:bash_assoc varname values sep hline)) (org-babel--variable-assignments:bash_assoc varname values sep hline))

View File

@ -2054,7 +2054,7 @@ in the buffer and update it."
(org-update-dblock)) (org-update-dblock))
(defun org-day-of-week (day month year) (defun org-day-of-week (day month year)
"Returns the day of the week as an integer." "Return the day of the week as an integer."
(nth 6 (nth 6
(decode-time (decode-time
(date-to-time (date-to-time

View File

@ -4757,7 +4757,7 @@ code."
;;;; For Tables ;;;; For Tables
;; ;;
;; `org-export-table-has-special-column-p' and and ;; `org-export-table-has-special-column-p' and
;; `org-export-table-row-is-special-p' are predicates used to look for ;; `org-export-table-row-is-special-p' are predicates used to look for
;; meta-information about the table structure. ;; meta-information about the table structure.
;; ;;