[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/org 51cdd6e: Various minor docfixes found by checkdoc
|
From: |
ELPA Syncer |
|
Subject: |
[elpa] externals/org 51cdd6e: Various minor docfixes found by checkdoc |
|
Date: |
Thu, 16 Sep 2021 15:57:16 -0400 (EDT) |
branch: externals/org
commit 51cdd6e30f72c0b32dd306639e55c22efeaa0e5e
Author: Stefan Kangas <stefan@marxist.se>
Commit: Marco Wahl <marcowahlsoft@gmail.com>
Various minor docfixes found by checkdoc
---
lisp/ob-C.el | 29 ++++++++++-------------------
lisp/ob-J.el | 2 +-
lisp/ob-abc.el | 7 +++++--
lisp/ob-comint.el | 2 +-
lisp/ob-core.el | 6 +++---
lisp/ob-ebnf.el | 8 ++++----
lisp/ob-eval.el | 2 +-
lisp/ob-fortran.el | 2 +-
lisp/ob-haskell.el | 2 +-
lisp/ob-io.el | 4 ++--
lisp/ob-js.el | 4 ++--
lisp/ob-ledger.el | 4 ++--
lisp/ob-lua.el | 6 ++++--
lisp/ob-makefile.el | 3 +--
lisp/ob-octave.el | 4 ++--
lisp/ob-picolisp.el | 10 +++++-----
lisp/ob-scheme.el | 2 +-
lisp/ob-screen.el | 2 +-
lisp/ob-tangle.el | 22 ++++++++++++++--------
lisp/oc-basic.el | 4 ++--
lisp/oc-csl.el | 2 +-
lisp/ol-bbdb.el | 2 +-
lisp/ol-eshell.el | 8 ++++----
lisp/ol-info.el | 2 +-
lisp/ol.el | 4 ++--
lisp/org-agenda.el | 21 +++++++++++----------
lisp/org-attach.el | 6 +++---
lisp/org-capture.el | 7 +++----
lisp/org-clock.el | 6 +++---
lisp/org-colview.el | 2 +-
lisp/org-ctags.el | 6 +++---
lisp/org-datetree.el | 4 ++--
lisp/org-element.el | 2 +-
lisp/org-goto.el | 2 +-
lisp/org-id.el | 2 +-
lisp/org-inlinetask.el | 2 +-
lisp/org-macro.el | 2 +-
lisp/org-macs.el | 4 ++--
lisp/org-mouse.el | 2 +-
lisp/org-num.el | 4 ++--
lisp/org-pcomplete.el | 5 ++---
lisp/org-src.el | 2 +-
lisp/org-table.el | 30 +++++++++++++++---------------
lisp/org.el | 26 +++++++++++++-------------
lisp/ox-html.el | 8 ++++----
lisp/ox-koma-letter.el | 8 ++++----
lisp/ox-latex.el | 2 +-
lisp/ox-man.el | 6 +++---
lisp/ox-odt.el | 11 +++++------
lisp/ox-publish.el | 2 +-
lisp/ox-texinfo.el | 6 +++---
51 files changed, 160 insertions(+), 161 deletions(-)
diff --git a/lisp/ob-C.el b/lisp/ob-C.el
index fdfe332..2878484 100644
--- a/lisp/ob-C.el
+++ b/lisp/ob-C.el
@@ -95,8 +95,7 @@ This function calls `org-babel-execute:C++'."
(org-babel-execute:C++ body params))
(defun org-babel-expand-body:cpp (body params)
- "Expand a block of C++ code with org-babel according to its
-header arguments."
+ "Expand a block of C++ code with org-babel according to its header
arguments."
(org-babel-expand-body:C++ body params))
(defun org-babel-execute:C++ (body params)
@@ -105,8 +104,7 @@ This function is called by `org-babel-execute-src-block'."
(let ((org-babel-c-variant 'cpp)) (org-babel-C-execute body params)))
(defun org-babel-expand-body:C++ (body params)
- "Expand a block of C++ code with org-babel according to its
-header arguments."
+ "Expand a block of C++ code with org-babel according to its header
arguments."
(let ((org-babel-c-variant 'cpp)) (org-babel-C-expand-C++ body params)))
(defun org-babel-execute:D (body params)
@@ -115,8 +113,7 @@ This function is called by `org-babel-execute-src-block'."
(let ((org-babel-c-variant 'd)) (org-babel-C-execute body params)))
(defun org-babel-expand-body:D (body params)
- "Expand a block of D code with org-babel according to its
-header arguments."
+ "Expand a block of D code with org-babel according to its header arguments."
(let ((org-babel-c-variant 'd)) (org-babel-C-expand-D body params)))
(defun org-babel-execute:C (body params)
@@ -125,8 +122,7 @@ This function is called by `org-babel-execute-src-block'."
(let ((org-babel-c-variant 'c)) (org-babel-C-execute body params)))
(defun org-babel-expand-body:C (body params)
- "Expand a block of C code with org-babel according to its
-header arguments."
+ "Expand a block of C code with org-babel according to its header arguments."
(let ((org-babel-c-variant 'c)) (org-babel-C-expand-C body params)))
(defun org-babel-C-execute (body params)
@@ -197,13 +193,11 @@ or `org-babel-execute:C++' or `org-babel-execute:D'."
)))
(defun org-babel-C-expand-C++ (body params)
- "Expand a block of C or C++ code with org-babel according to
-its header arguments."
+ "Expand a block of C/C++ code with org-babel according to its header
arguments."
(org-babel-C-expand-C body params))
(defun org-babel-C-expand-C (body params)
- "Expand a block of C or C++ code with org-babel according to
-its header arguments."
+ "Expand a block of C/C++ code with org-babel according to its header
arguments."
(let ((vars (org-babel--get-vars params))
(colnames (cdr (assq :colname-names params)))
(main-p (not (string= (cdr (assq :main params)) "no")))
@@ -272,8 +266,7 @@ its header arguments."
body) "\n") "\n")))
(defun org-babel-C-expand-D (body params)
- "Expand a block of D code with org-babel according to
-its header arguments."
+ "Expand a block of D code with org-babel according to its header arguments."
(let ((vars (org-babel--get-vars params))
(colnames (cdr (assq :colname-names params)))
(main-p (not (string= (cdr (assq :main params)) "no")))
@@ -348,7 +341,7 @@ FORMAT can be either a format string or a function which is
called with VAL."
(list
(if (eq org-babel-c-variant 'd) "string" "const char*")
"\"%s\""))
- (_ (error "unknown type %S" basetype)))))
+ (_ (error "Unknown type %S" basetype)))))
(cond
((integerp val) type) ;; an integer declared in the #+begin_src line
((floatp val) type) ;; a numeric declared in the #+begin_src line
@@ -405,8 +398,7 @@ FORMAT can be either a format string or a function which is
called with VAL."
(t 'stringp)))
(defun org-babel-C-var-to-C (pair)
- "Convert an elisp val into a string of C code specifying a var
-of the same value."
+ "Convert an elisp val into a string of C code specifying a var of the same
value."
;; TODO list support
(let ((var (car pair))
(val (cdr pair)))
@@ -446,8 +438,7 @@ of the same value."
(format "const int %s_cols = %d;" (car pair) (length (cdr pair)))))))
(defun org-babel-C-utility-header-to-C ()
- "Generate a utility function to convert a column name
-into a column number."
+ "Generate a utility function to convert a column name into a column number."
(pcase org-babel-c-variant
((or `c `cpp)
(concat
diff --git a/lisp/ob-J.el b/lisp/ob-J.el
index 0c5591d..306ad0f 100644
--- a/lisp/ob-J.el
+++ b/lisp/ob-J.el
@@ -92,7 +92,7 @@ This function is called by `org-babel-execute-src-block'."
(org-babel-J-eval-string full-body sit-time)))))
(defun org-babel-J-eval-string (str sit-time)
- "Sends STR to the `j-console-cmd' session and executes it."
+ "Sends STR to the `j-console-cmd' session and execute it."
(let ((session (j-console-ensure-session)))
(with-current-buffer (process-buffer session)
(goto-char (point-max))
diff --git a/lisp/ob-abc.el b/lisp/ob-abc.el
index dd93828..83a38a8 100644
--- a/lisp/ob-abc.el
+++ b/lisp/ob-abc.el
@@ -28,9 +28,12 @@
;;; It requires that the abcm2ps program is installed.
;;; See http://moinejf.free.fr/
+;;; Code:
+
(require 'ob)
;; optionally define a file extension for this language
+
(add-to-list 'org-babel-tangle-lang-exts '("abc" . "abc"))
;; optionally declare default header arguments for this language
@@ -54,8 +57,8 @@
body))
(defun org-babel-execute:abc (body params)
- "Execute a block of ABC code with org-babel. This function is
- called by `org-babel-execute-src-block'"
+ "Execute a block of ABC code with org-babel.
+This function is called by `org-babel-execute-src-block'."
(message "executing Abc source code block")
(let* ((cmdline (cdr (assq :cmdline params)))
(out-file (let ((file (cdr (assq :file params))))
diff --git a/lisp/ob-comint.el b/lisp/ob-comint.el
index 539aafa..2727071 100644
--- a/lisp/ob-comint.el
+++ b/lisp/ob-comint.el
@@ -276,7 +276,7 @@ STRING contains the output originally inserted into the
comint buffer."
(defun org-babel-comint-async-register
(session-buffer org-buffer indicator-regexp
chunk-callback file-callback)
- "Sets local org-babel-comint-async variables in SESSION-BUFFER.
+ "Set local org-babel-comint-async variables in SESSION-BUFFER.
ORG-BUFFER is added to `org-babel-comint-async-buffers' if not
present. `org-babel-comint-async-indicator',
`org-babel-comint-async-chunk-callback', and
diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index 1fc3b3d..f3b495f 100644
--- a/lisp/ob-core.el
+++ b/lisp/ob-core.el
@@ -538,7 +538,7 @@ to raise errors for all languages.")
"Number of initial characters to show of a hidden results hash.")
(defvar org-babel-after-execute-hook nil
- "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)
"Generate a regexp used to match a source block named NAME.
@@ -1706,7 +1706,7 @@ of the vars, cnames and rnames."
(defun org-babel-reassemble-table (table colnames rownames)
"Add column and row names to a table.
Given a TABLE and set of COLNAMES and ROWNAMES add the names
-to the table for reinsertion to org-mode."
+to the table for reinsertion to `org-mode'."
(if (listp table)
(let ((table (if (and rownames (= (length table) (length rownames)))
(org-babel-put-rownames table rownames) table)))
@@ -2966,7 +2966,7 @@ block but are passed literally to the \"example-block\"."
(defun org-babel-read (cell &optional inhibit-lisp-eval)
"Convert the string value of CELL to a number if appropriate.
-Otherwise if CELL looks like lisp (meaning it starts with a
+Otherwise if CELL looks like Lisp (meaning it starts with a
\"(\", \"\\='\", \"\\=`\" or a \"[\") then read and evaluate it as
lisp, otherwise return it unmodified as a string. Optional
argument INHIBIT-LISP-EVAL inhibits lisp evaluation for
diff --git a/lisp/ob-ebnf.el b/lisp/ob-ebnf.el
index 58666a4..77975e5 100644
--- a/lisp/ob-ebnf.el
+++ b/lisp/ob-ebnf.el
@@ -24,15 +24,15 @@
;;; Commentary:
;; Org-Babel support for using ebnf2ps to generate encapsulated postscript
-;; railroad diagrams. It recognizes these arguments:
+;; railroad diagrams. It recognizes these arguments:
;;
;; :file is required; it must include the extension '.eps.' All the rules
-;; in the block will be drawn in the same file. This is done by
+;; in the block will be drawn in the same file. This is done by
;; inserting a '[<file>' comment at the start of the block (see the
;; documentation for ebnf-eps-buffer for more information).
;;
-;; :style specifies a value in ebnf-style-database. This provides the
-;; ability to customize the output. The style can also specify the
+;; :style specifies a value in ebnf-style-database. This provides the
+;; ability to customize the output. The style can also specify the
;; grammar syntax (by setting ebnf-syntax); note that only ebnf,
;; iso-ebnf, and yacc are supported by this file.
diff --git a/lisp/ob-eval.el b/lisp/ob-eval.el
index cfde4f1..cfd8022 100644
--- a/lisp/ob-eval.el
+++ b/lisp/ob-eval.el
@@ -44,7 +44,7 @@
(defun org-babel-eval (command query)
"Run COMMAND on QUERY.
Writes QUERY into a temp-buffer that is processed with
-org-babel--shell-command-on-region. If COMMAND succeeds then return
+`org-babel--shell-command-on-region'. If COMMAND succeeds then return
its results, otherwise display STDERR with
`org-babel-eval-error-notify'."
(let ((error-buffer (get-buffer-create " *Org-Babel Error*")) exit-code)
diff --git a/lisp/ob-fortran.el b/lisp/ob-fortran.el
index 6cf3a79..2e55498 100644
--- a/lisp/ob-fortran.el
+++ b/lisp/ob-fortran.el
@@ -157,7 +157,7 @@ of the same value."
(format "real, parameter :: %S(%d) = %s\n"
var (length val) (org-babel-fortran-transform-list val)))
(t
- (error "the type of parameter %s is not supported by ob-fortran" var)))))
+ (error "The type of parameter %s is not supported by ob-fortran" var)))))
(defun org-babel-fortran-transform-list (val)
"Return a fortran representation of enclose syntactic lists."
diff --git a/lisp/ob-haskell.el b/lisp/ob-haskell.el
index c8d2809..a6f0e55 100644
--- a/lisp/ob-haskell.el
+++ b/lisp/ob-haskell.el
@@ -74,7 +74,7 @@ a parameter, such as \"ghc -v\"."
"Haskell-specific header arguments.")
(defun org-babel-haskell-execute (body params)
- "This function should only be called by `org-babel-execute:haskell'"
+ "This function should only be called by `org-babel-execute:haskell'."
(let* ((tmp-src-file (org-babel-temp-file "Haskell-src-" ".hs"))
(tmp-bin-file
(org-babel-process-file-name
diff --git a/lisp/ob-io.el b/lisp/ob-io.el
index a366d6d..5955977 100644
--- a/lisp/ob-io.el
+++ b/lisp/ob-io.el
@@ -95,8 +95,8 @@ in BODY as elisp."
(error "Sessions are not (yet) supported for Io"))
(defun org-babel-io-initiate-session (&optional _session)
- "If there is not a current inferior-process-buffer in SESSION
-then create. Return the initialized session. Sessions are not
+ "If there is not a current inferior-process-buffer in SESSION then create.
+Return the initialized session. Sessions are not
supported in Io."
nil)
diff --git a/lisp/ob-js.el b/lisp/ob-js.el
index b2a971e..5d1be61 100644
--- a/lisp/ob-js.el
+++ b/lisp/ob-js.el
@@ -158,8 +158,8 @@ specifying a variable of the same value."
(org-babel--get-vars params)))
(defun org-babel-js-initiate-session (&optional session _params)
- "If there is not a current inferior-process-buffer in `SESSION'
-then create. Return the initialized session."
+ "If there is not a current inferior-process-buffer in `SESSION' then create.
+Return the initialized session."
(cond
((string= session "none")
(warn "Session evaluation of ob-js is not supported"))
diff --git a/lisp/ob-ledger.el b/lisp/ob-ledger.el
index 9407960..291c35b 100644
--- a/lisp/ob-ledger.el
+++ b/lisp/ob-ledger.el
@@ -44,8 +44,8 @@
"Default arguments to use when evaluating a ledger source block.")
(defun org-babel-execute:ledger (body params)
- "Execute a block of Ledger entries with org-babel. This function is
-called by `org-babel-execute-src-block'."
+ "Execute a block of Ledger entries with org-babel.
+This function is called by `org-babel-execute-src-block'."
(message "executing Ledger source code block")
(let ((cmdline (cdr (assq :cmdline params)))
(in-file (org-babel-temp-file "ledger-"))
diff --git a/lisp/ob-lua.el b/lisp/ob-lua.el
index 11503e4..a4a964a 100644
--- a/lisp/ob-lua.el
+++ b/lisp/ob-lua.el
@@ -21,6 +21,10 @@
;; 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:
+
+;; Org-Babel support for evaluating lua source code.
+
;; Requirements:
;; for session support, lua-mode is needed.
;; lua-mode is not part of GNU Emacs/orgmode, but can be obtained
@@ -30,8 +34,6 @@
;; However, sessions are not yet working.
-;; Org-Babel support for evaluating lua source code.
-
;;; Code:
(require 'ob)
(require 'org-macs)
diff --git a/lisp/ob-makefile.el b/lisp/ob-makefile.el
index 69ab6fe..eae64cf 100644
--- a/lisp/ob-makefile.el
+++ b/lisp/ob-makefile.el
@@ -37,8 +37,7 @@ This function is called by `org-babel-execute-src-block'."
body)
(defun org-babel-prep-session:makefile (_session _params)
- "Return an error if the :session header argument is set. Make
-does not support sessions."
+ "Signal error; Make does not support sessions."
(error "Makefile sessions are nonsensical"))
(provide 'ob-makefile)
diff --git a/lisp/ob-octave.el b/lisp/ob-octave.el
index 166cd59..7dc12d9 100644
--- a/lisp/ob-octave.el
+++ b/lisp/ob-octave.el
@@ -45,8 +45,8 @@
(defvar org-babel-matlab-with-emacs-link nil
"If non-nil use matlab-shell-run-region for session evaluation.
- This will use EmacsLink if (matlab-with-emacs-link) evaluates
- to a non-nil value.")
+This will use EmacsLink if (matlab-with-emacs-link) evaluates
+to a non-nil value.")
(defvar org-babel-matlab-emacs-link-wrapper-method
"%s
diff --git a/lisp/ob-picolisp.el b/lisp/ob-picolisp.el
index a867523..102389d 100644
--- a/lisp/ob-picolisp.el
+++ b/lisp/ob-picolisp.el
@@ -26,13 +26,13 @@
;; This library enables the use of PicoLisp in the multi-language
;; programming framework Org-Babel. PicoLisp is a minimal yet
-;; fascinating lisp dialect and a highly productive application
+;; fascinating Lisp dialect and a highly productive application
;; framework for web-based client-server applications on top of
;; object-oriented databases. A good way to learn PicoLisp is to first
;; read Paul Grahams essay "The hundred year language"
;; (http://www.paulgraham.com/hundred.html) and then study the various
;; documents and essays published in the PicoLisp wiki
-;; (https://picolisp.com/5000/-2.html). PicoLisp is included in some
+;; (https://picolisp.com/5000/-2.html). PicoLisp is included in some
;; GNU/Linux Distributions, and can be downloaded here:
;; https://software-lab.de/down.html. It ships with a picolisp-mode and
;; an inferior-picolisp-mode for Emacs (to be found in the /lib/el/
@@ -44,7 +44,7 @@
;; make it a valuable addition to Org Babel:
;; PicoLisp _is_ an object-oriented database with a Prolog-based query
-;; language implemented in PicoLisp (Pilog). Database objects are
+;; language implemented in PicoLisp (Pilog). Database objects are
;; first-class members of the language.
;; PicoLisp is an extremely productive framework for the development
@@ -166,8 +166,8 @@ This function is called by `org-babel-execute-src-block'."
(read result))))
(defun org-babel-picolisp-initiate-session (&optional session-name)
- "If there is not a current inferior-process-buffer in SESSION
-then create. Return the initialized session."
+ "If there is not a current inferior-process-buffer in SESSION then create.
+Return the initialized session."
(unless (string= session-name "none")
(require 'inferior-picolisp)
;; provide a reasonable default session name
diff --git a/lisp/ob-scheme.el b/lisp/ob-scheme.el
index a18bfb5..f4836b2 100644
--- a/lisp/ob-scheme.el
+++ b/lisp/ob-scheme.el
@@ -110,7 +110,7 @@
geiser-impl--implementation))
(defun org-babel-scheme-get-repl (impl name)
- "Switch to a scheme REPL, creating it if it doesn't exist:"
+ "Switch to a scheme REPL, creating it if it doesn't exist."
(let ((buffer (org-babel-scheme-get-session-buffer name)))
(or buffer
(progn
diff --git a/lisp/ob-screen.el b/lisp/ob-screen.el
index c69bcd9..7793825 100644
--- a/lisp/ob-screen.el
+++ b/lisp/ob-screen.el
@@ -30,7 +30,7 @@
;; Adding :cmd and :terminal as header arguments
;; :terminal must support the -T (title) and -e (command) parameter
;;
-;; You can test the default setup. (xterm + sh) with
+;; You can test the default setup (xterm + sh) with
;; M-x org-babel-screen-test RET
;;; Code:
diff --git a/lisp/ob-tangle.el b/lisp/ob-tangle.el
index 2f60ef9..b5c22c5 100644
--- a/lisp/ob-tangle.el
+++ b/lisp/ob-tangle.el
@@ -169,11 +169,14 @@ evaluating BODY."
(defun org-babel-tangle-file (file &optional target-file lang-re)
"Extract the bodies of source code blocks in FILE.
Source code blocks are extracted with `org-babel-tangle'.
+
Optional argument TARGET-FILE can be used to specify a default
-export file for all source blocks. Optional argument LANG-RE can
-be used to limit the exported source code blocks by languages
-matching a regular expression. Return a list whose CAR is the
-tangled file name."
+export file for all source blocks.
+
+Optional argument LANG-RE can be used to limit the exported
+source code blocks by languages matching a regular expression.
+
+Return a list whose CAR is the tangled file name."
(interactive "fFile to tangle: \nP")
(let ((visited-p (find-buffer-visiting (expand-file-name file)))
to-be-removed)
@@ -371,10 +374,13 @@ as computed by `org-babel-tangle-single-block'."
"Collect source blocks in the current Org file.
Return an association list of language and source-code block
specifications of the form used by `org-babel-spec-to-string'
-grouped by tangled file name. Optional argument LANG-RE can be
-used to limit the collected source code blocks by languages
-matching a regular expression. Optional argument TANGLE-FILE can
-be used to limit the collected code blocks by target file."
+grouped by tangled file name.
+
+Optional argument LANG-RE can be used to limit the collected
+source code blocks by languages matching a regular expression.
+
+Optional argument TANGLE-FILE can be used to limit the collected
+code blocks by target file."
(let ((counter 0) last-heading-pos blocks)
(org-babel-map-src-blocks (buffer-file-name)
(let ((current-heading-pos
diff --git a/lisp/oc-basic.el b/lisp/oc-basic.el
index f16eb25..3b58990 100644
--- a/lisp/oc-basic.el
+++ b/lisp/oc-basic.el
@@ -632,7 +632,7 @@ export communication channel, as a property list."
(defun org-cite-basic-export-bibliography (keys _files style _props backend
info)
"Generate bibliography.
KEYS is the list of cited keys, as strings. STYLE is the expected bibliography
-style, as a string. BACKEND is the export back-end, as a symbol. INFO is the
+style, as a string. BACKEND is the export back-end, as a symbol. INFO is the
export state, as a property list."
(mapconcat
(lambda (k)
@@ -767,4 +767,4 @@ Raise an error when no bibliography is set in the buffer."
(("nil") ("bare" "b") ("bare-caps" "bc") ("caps" "c"))))
(provide 'oc-basic)
-;;; oc-default.el ends here
+;;; oc-basic.el ends here
diff --git a/lisp/oc-csl.el b/lisp/oc-csl.el
index 36a8856..b5074dc 100644
--- a/lisp/oc-csl.el
+++ b/lisp/oc-csl.el
@@ -609,4 +609,4 @@ property list."
(("nil") ("bare" "b") ("bare-caps" "bc") ("caps" "c"))))
(provide 'oc-csl)
-;;; oc-citeproc.el ends here
+;;; oc-csl.el ends here
diff --git a/lisp/ol-bbdb.el b/lisp/ol-bbdb.el
index 36bce0e..f697f1f 100644
--- a/lisp/ol-bbdb.el
+++ b/lisp/ol-bbdb.el
@@ -60,7 +60,7 @@
;;
;; CLASS-OR-FORMAT-STRING is one of two things:
;;
-;; - an identifier for a class of anniversaries (eg. birthday or
+;; - an identifier for a class of anniversaries (e.g. birthday or
;; wedding) from `org-bbdb-anniversary-format-alist' which then
;; defines the format string for this class
;; - the (format) string displayed in the diary.
diff --git a/lisp/ol-eshell.el b/lisp/ol-eshell.el
index 8920e0a..a7550e3 100644
--- a/lisp/ol-eshell.el
+++ b/lisp/ol-eshell.el
@@ -35,9 +35,9 @@
(defun org-eshell-open (link _)
"Switch to an eshell buffer and execute a command line.
- The link can be just a command line (executed in the default
- eshell buffer) or a command line prefixed by a buffer name
- followed by a colon."
+The link can be just a command line (executed in the default
+eshell buffer) or a command line prefixed by a buffer name
+followed by a colon."
(let* ((buffer-and-command
(if (string-match "\\([A-Za-z0-9+*-]+\\):\\(.*\\)" link)
(list (match-string 1 link)
@@ -55,7 +55,7 @@
(defun org-eshell-store-link ()
"Store a link that, when opened, switches back to the current eshell buffer
- and the current working directory."
+and the current working directory."
(when (eq major-mode 'eshell-mode)
(let* ((command (concat "cd " (eshell/pwd)))
(link (concat (buffer-name) ":" command)))
diff --git a/lisp/ol-info.el b/lisp/ol-info.el
index b1f3718..a535ea5 100644
--- a/lisp/ol-info.el
+++ b/lisp/ol-info.el
@@ -91,7 +91,7 @@
"pgg" "rcirc" "reftex" "remember" "sasl" "sc" "semantic" "ses" "sieve"
"smtpmail" "speedbar" "srecode" "todo-mode" "tramp" "url" "vip" "viper"
"widget" "wisent" "woman")
- "List of emacs documents available.
+ "List of Emacs documents available.
Taken from <https://www.gnu.org/software/emacs/manual/html_mono/.>")
(defconst org-info-other-documents
diff --git a/lisp/ol.el b/lisp/ol.el
index 1eeb2bc..7862ded 100644
--- a/lisp/ol.el
+++ b/lisp/ol.el
@@ -506,7 +506,7 @@ links more efficient."
"Regular expression matching radio targets in plain text.")
(defvar org-link-types-re nil
- "Matches a link that has a url-like prefix like \"http:\"")
+ "Matches a link that has a url-like prefix like \"http:\".")
(defvar org-link-angle-re nil
"Matches link with angular brackets, spaces are allowed.")
@@ -929,7 +929,7 @@ and dates."
(defun org-link-encode (text table)
"Return percent escaped representation of string TEXT.
-TEXT is a string with the text to escape. TABLE is a list of
+TEXT is a string with the text to escape. TABLE is a list of
characters that should be escaped."
(mapconcat
(lambda (c)
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 3035823..869c6c1 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -2468,7 +2468,7 @@ The following commands are available:
(when org-agenda-mouse-1-follows-link
(org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
-(easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
+(easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu."
'("Agenda"
("Agenda Files")
"--"
@@ -3765,7 +3765,7 @@ the global options and expect it to be applied to the
entire view.")
(tag . org-agenda-tag-filter)
(effort . org-agenda-effort-filter)
(regexp . org-agenda-regexp-filter))
- "Alist of filter types and associated variables")
+ "Alist of filter types and associated variables.")
(defun org-agenda-filter-any ()
"Is any filter active?"
(cl-some (lambda (x)
@@ -4306,7 +4306,7 @@ items if they have an hour specification like [h]h:mm."
(setq span arg arg nil))
(when (numberp span)
(unless (< 0 span)
- (user-error "Agenda creation impossible for this span(=%d days)." span)))
+ (user-error "Agenda creation impossible for this span(=%d days)" span)))
(catch 'exit
(setq org-agenda-buffer-name
(org-agenda--get-buffer-name
@@ -5062,7 +5062,7 @@ See `org-agenda-skip-if' for details."
(org-agenda-skip-if t conditions))
(defun org-agenda-skip-if (subtree conditions)
- "Checks current entity for CONDITIONS.
+ "Check current entity for CONDITIONS.
If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
the entry (i.e. the text before the next heading) is checked.
@@ -7806,7 +7806,7 @@ A single `\\[universal-argument]' prefix arg
STRIP-OR-ACCUMULATE will negate the
entire filter, which can be useful in connection with the prompt history.
A double `\\[universal-argument] \\[universal-argument]' prefix arg will add
the new filter elements to the
-existing ones. A shortcut for this is to add an additional `+' at the
+existing ones. A shortcut for this is to add an additional `+' at the
beginning of the string, like `+-John'.
With a triple prefix argument, execute the computed filtering defined in
@@ -7957,7 +7957,7 @@ With a `\\[universal-argument] \\[universal-argument]
\\[universal-argument]' pr
i.e. don't
filter on all its group members.
-A lisp caller can specify CHAR. EXCLUDE means that the new tag
+A Lisp caller can specify CHAR. EXCLUDE means that the new tag
should be used to exclude the search - the interactive user can
also press `-' or `+' to switch between filtering and excluding."
(interactive "P")
@@ -8070,9 +8070,10 @@ These will be lower-case, for filtering."
(setq org-agenda-represented-tags tags-lists)))))
(defun org-agenda-filter-make-matcher (filter type &optional expand)
- "Create the form that tests a line for agenda filter. Optional
-argument EXPAND can be used for the TYPE tag and will expand the
-tags in the FILTER if any of the tags in FILTER are grouptags."
+ "Create the form that tests a line for agenda filter.
+Optional argument EXPAND can be used for the TYPE tag and will
+expand the tags in the FILTER if any of the tags in FILTER are
+grouptags."
(let ((multi-pos-cats
(and (eq type 'category)
(string-match-p "\\+.*\\+"
@@ -8936,7 +8937,7 @@ Point is in the buffer where the item originated.")
(defun org-agenda-do-in-region (beg end cmd &optional arg force-arg delete)
"Between region BEG and END, call agenda command CMD.
-When optional argument ARG is non-nil or FORCE-ARG is `t', pass
+When optional argument ARG is non-nil or FORCE-ARG is t, pass
ARG to CMD. When optional argument DELETE is non-nil, assume CMD
deletes the agenda entry and don't move to the next entry."
(save-excursion
diff --git a/lisp/org-attach.el b/lisp/org-attach.el
index f184531..162a01e 100644
--- a/lisp/org-attach.el
+++ b/lisp/org-attach.el
@@ -120,7 +120,7 @@ lns create a symbol link. Note that this is not supported
(defcustom org-attach-use-inheritance 'selective
"Attachment inheritance for the outline.
-Enabling inheritance for org-attach implies two things. First,
+Enabling inheritance for `org-attach' implies two things. First,
that attachment links will look through all parent headings until
it finds the linked attachment. Second, that running org-attach
inside a node without attachments will make org-attach operate on
@@ -385,7 +385,7 @@ If the attachment by some reason cannot be created an error
will be raised."
attach-dir))
(defun org-attach-dir-from-id (id &optional try-all)
- "Returns a folder path based on `org-attach-id-dir' and ID.
+ "Return a folder path based on `org-attach-id-dir' and ID.
If TRY-ALL is non-nil, try all id-to-path functions in
`org-attach-id-to-path-function-list' and return the first path
that exist in the filesystem, or the first one if none exist.
@@ -446,7 +446,7 @@ Return the directory."
new))
(defun org-attach-unset-directory ()
- "Removes DIR node property.
+ "Remove DIR node property.
If attachment folder is changed due to removal of DIR-property
ask to move attachments to new location and ask to delete old
attachment-folder.
diff --git a/lisp/org-capture.el b/lisp/org-capture.el
index c517446..cbdb30c 100644
--- a/lisp/org-capture.el
+++ b/lisp/org-capture.el
@@ -108,7 +108,7 @@
(defun org-capture-upgrade-templates (templates)
"Update the template list to the new format.
-TEMPLATES is a template list, as in `org-capture-templates'. The
+TEMPLATES is a template list, as in `org-capture-templates'. The
new format unifies all the date/week tree targets into one that
also allows for an optional outline path to specify a target."
(let ((modified-templates
@@ -475,8 +475,7 @@ The capture buffer is current and still narrowed."
:type 'hook)
(defcustom org-capture-bookmark t
- "When non-nil, add a bookmark pointing at the last stored
-position when capturing."
+ "When non-nil, add bookmark pointing at the last stored position when
capturing."
:group 'org-capture
:version "24.3"
:type 'boolean)
@@ -496,7 +495,7 @@ is copied to this variable, which is local in the indirect
buffer.")
(defvar org-capture-clock-keep nil
"Local variable to store the value of the :clock-keep parameter.
-This is needed in case org-capture-finalize is called interactively.")
+This is needed in case `org-capture-finalize' is called interactively.")
(defun org-capture-put (&rest stuff)
"Add properties to the capture property list `org-capture-plist'."
diff --git a/lisp/org-clock.el b/lisp/org-clock.el
index cd930e8..9877607 100644
--- a/lisp/org-clock.el
+++ b/lisp/org-clock.el
@@ -85,7 +85,7 @@ function `org-clock-into-drawer' instead."
(string :tag "Into Drawer named...")))
(defun org-clock-into-drawer ()
- "Value of `org-clock-into-drawer'. but let properties overrule.
+ "Value of `org-clock-into-drawer', but let properties overrule.
If the current entry has or inherits a CLOCK_INTO_DRAWER
property, it will be used instead of the default value.
@@ -513,9 +513,9 @@ to add an effort property.")
"Has the clock been used during the current Emacs session?")
(defvar org-clock-stored-history nil
- "Clock history, populated by `org-clock-load'")
+ "Clock history, populated by `org-clock-load'.")
(defvar org-clock-stored-resume-clock nil
- "Clock to resume, saved by `org-clock-load'")
+ "Clock to resume, saved by `org-clock-load'.")
;;; The clock for measuring work time.
diff --git a/lisp/org-colview.el b/lisp/org-colview.el
index 7144308..ea65888 100644
--- a/lisp/org-colview.el
+++ b/lisp/org-colview.el
@@ -213,7 +213,7 @@ See `org-columns-summary-types' for details.")
(lambda () (interactive)
(org-columns-next-allowed-value nil i))))
-(easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
+(easy-menu-define org-columns-menu org-columns-map "Org Column Menu."
'("Column"
["Edit property" org-columns-edit-value t]
["Next allowed value" org-columns-next-allowed-value t]
diff --git a/lisp/org-ctags.el b/lisp/org-ctags.el
index dc2b3be..7876c6e 100644
--- a/lisp/org-ctags.el
+++ b/lisp/org-ctags.el
@@ -3,10 +3,8 @@
;; Copyright (C) 2007-2021 Free Software Foundation, Inc.
;; Author: Paul Sexton <eeeickythump@gmail.com>
-
-
;; Keywords: org, wp
-;;
+
;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software: you can redistribute it and/or modify
@@ -22,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:
+
;;
;; Synopsis
;; ========
diff --git a/lisp/org-datetree.el b/lisp/org-datetree.el
index ac49187..74442b0 100644
--- a/lisp/org-datetree.el
+++ b/lisp/org-datetree.el
@@ -72,8 +72,8 @@ will be built under the headline at point."
(defun org-datetree--find-create-group
(d time-grouping &optional keep-restriction)
"Find or create an entry for date D.
-If time-period is day, group entries by day. If time-period is
-month, then group entries by month."
+If time-period is day, group entries by day.
+If time-period is month, then group entries by month."
(setq-local org-datetree-base-level 1)
(save-restriction
(if (eq keep-restriction 'subtree-at-point)
diff --git a/lisp/org-element.el b/lisp/org-element.el
index 006e75a..2dfbaea 100644
--- a/lisp/org-element.el
+++ b/lisp/org-element.el
@@ -4489,7 +4489,7 @@ element or object. Meaningful values are `first-section',
TYPE is the type of the current element or object.
If PARENT? is non-nil, assume the next element or object will be
-located inside the current one. "
+located inside the current one."
(if parent?
(pcase type
(`headline 'section)
diff --git a/lisp/org-goto.el b/lisp/org-goto.el
index 940bb73..c9cf1f6 100644
--- a/lisp/org-goto.el
+++ b/lisp/org-goto.el
@@ -250,7 +250,7 @@ want.
This command works around this by showing a copy of the current
buffer in an indirect buffer, in overview mode. You can dive
-into the tree in that copy, use org-occur and incremental search
+into the tree in that copy, use `org-occur' and incremental search
to find a location. When pressing RET or `Q', the command
returns to the original buffer in which the visibility is still
unchanged. After RET it will also jump to the location selected
diff --git a/lisp/org-id.el b/lisp/org-id.el
index 784f41c..3725ff9 100644
--- a/lisp/org-id.el
+++ b/lisp/org-id.el
@@ -204,7 +204,7 @@ This variable is only relevant when `org-id-track-globally'
is set."
:type 'file)
(defcustom org-id-locations-file-relative nil
- "Determines if org-id-locations should be stored as relative links.
+ "Determine if `org-id-locations' should be stored as relative links.
Non-nil means that links to locations are stored as links
relative to the location of where `org-id-locations-file' is
stored.
diff --git a/lisp/org-inlinetask.el b/lisp/org-inlinetask.el
index f19353b..afa2892 100644
--- a/lisp/org-inlinetask.el
+++ b/lisp/org-inlinetask.el
@@ -189,7 +189,7 @@ The number of levels is controlled by
`org-inlinetask-min-level'."
(defun org-inlinetask-goto-end ()
"Go to the end of the inline task at point.
- Return point."
+Return point."
(save-match-data
(beginning-of-line)
(let ((case-fold-search t)
diff --git a/lisp/org-macro.el b/lisp/org-macro.el
index c3fbce1..b8d3373 100644
--- a/lisp/org-macro.el
+++ b/lisp/org-macro.el
@@ -30,7 +30,7 @@
;; `org-macro-initialize-templates', which recursively calls
;; `org-macro--collect-macros' in order to read setup files.
-;; Argument in macros are separated with commas. Proper escaping rules
+;; Argument in macros are separated with commas. Proper escaping rules
;; are implemented in `org-macro-escape-arguments' and arguments can
;; be extracted from a string with `org-macro-extract-arguments'.
diff --git a/lisp/org-macs.el b/lisp/org-macs.el
index 65db8f8..18ae642 100644
--- a/lisp/org-macs.el
+++ b/lisp/org-macs.el
@@ -1154,13 +1154,13 @@ move it back by one char before doing this check."
(org-invisible-p)))
(defun org-find-visible ()
- "Return closest visible buffer position, or `point-max'"
+ "Return closest visible buffer position, or `point-max'."
(if (org-invisible-p)
(next-single-char-property-change (point) 'invisible)
(point)))
(defun org-find-invisible ()
- "Return closest invisible buffer position, or `point-max'"
+ "Return closest invisible buffer position, or `point-max'."
(if (org-invisible-p)
(point)
(next-single-char-property-change (point) 'invisible)))
diff --git a/lisp/org-mouse.el b/lisp/org-mouse.el
index b318670..4471d8e 100644
--- a/lisp/org-mouse.el
+++ b/lisp/org-mouse.el
@@ -161,7 +161,7 @@ it is intended to operate on. If nil, then the action has
been invoked
indirectly, for example, through the agenda buffer.")
(defgroup org-mouse nil
- "Mouse support for org-mode."
+ "Mouse support for `org-mode'."
:tag "Org Mouse"
:group 'org)
diff --git a/lisp/org-num.el b/lisp/org-num.el
index 46f8e7c..408b86f 100644
--- a/lisp/org-num.el
+++ b/lisp/org-num.el
@@ -29,8 +29,8 @@
;; to toggle it.
;;
;; You can select what is numbered according to level, tags, COMMENT
-;; keyword, or UNNUMBERED property. You can also skip footnotes
-;; sections. See `org-num-max-level', `org-num-skip-tags',
+;; keyword, or UNNUMBERED property. You can also skip footnotes
+;; sections. See `org-num-max-level', `org-num-skip-tags',
;; `org-num-skip-commented', `org-num-skip-unnumbered', and
;; `org-num-skip-footnotes' for details.
;;
diff --git a/lisp/org-pcomplete.el b/lisp/org-pcomplete.el
index 171167b..b31dc33 100644
--- a/lisp/org-pcomplete.el
+++ b/lisp/org-pcomplete.el
@@ -21,8 +21,7 @@
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;
+
;;; Code:
;;;; Require other packages
@@ -186,7 +185,7 @@ When completing for #+STARTUP, for example, this function
returns
(cons (reverse args) (reverse begins))))))
(defun org-pcomplete-initial ()
- "Calls the right completion function for first argument completions."
+ "Call the right completion function for first argument completions."
(ignore
(funcall (or (pcomplete-find-completion-function
(car (org-thing-at-point)))
diff --git a/lisp/org-src.el b/lisp/org-src.el
index 4698c6d..743e9e1 100644
--- a/lisp/org-src.el
+++ b/lisp/org-src.el
@@ -584,7 +584,7 @@ Leave point in edit buffer."
(defun org-src-font-lock-fontify-block (lang start end)
"Fontify code block.
-This function is called by emacs automatic fontification, as long
+This function is called by Emacs' automatic fontification, as long
as `org-src-fontify-natively' is non-nil."
(let ((lang-mode (org-src-get-lang-mode lang)))
(when (fboundp lang-mode)
diff --git a/lisp/org-table.el b/lisp/org-table.el
index cc69542..639c991 100644
--- a/lisp/org-table.el
+++ b/lisp/org-table.el
@@ -331,7 +331,7 @@ relies on the variables to be present in the list."
The default value is `hours', and will output the results as a
number of hours. Other allowed values are `seconds', `minutes' and
`days', and the output will be a fraction of seconds, minutes or
-days. `hh:mm' selects to use hours and minutes, ignoring seconds.
+days. `hh:mm' selects to use hours and minutes, ignoring seconds.
The `U' flag in a table formula will select this specific format for
a single formula."
:group 'org-table-calculation
@@ -3267,7 +3267,7 @@ Parameters get priority."
(org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
map))
-(easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas
Menu"
+(easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas
Menu."
'("Edit-Formulas"
["Finish and Install" org-table-fedit-finish t]
["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c
C-c"]
@@ -5076,7 +5076,7 @@ When LOCAL is non-nil, show references for the table at
point."
(put 'orgtbl-mode :included t)
(put 'orgtbl-mode :menu-tag "Org Table Mode")
-(easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
+(easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu."
'("OrgTbl"
["Create or convert" org-table-create-or-convert-from-region
:active (not (org-at-table-p)) :keys "C-c |" ]
@@ -5326,7 +5326,7 @@ With prefix arg, also recompute table."
(defun orgtbl-create-or-convert-from-region (_arg)
"Create table or convert region to table, if no conflicting binding.
This installs the table binding `C-c |', but only if there is no
-conflicting binding to this key outside orgtbl-mode."
+conflicting binding to this key outside `orgtbl-mode'."
(interactive "P")
(let* (orgtbl-mode (cmd (key-binding "\C-c|")))
(if cmd
@@ -5565,7 +5565,7 @@ First element has index 0, or I0 if given."
;;;###autoload
(defun orgtbl-to-generic (table params)
- "Convert the orgtbl-mode TABLE to some other format.
+ "Convert the `orgtbl-mode' TABLE to some other format.
This generic routine can be used for many standard cases.
@@ -5952,12 +5952,12 @@ information."
;;;###autoload
(defun orgtbl-to-tsv (table params)
- "Convert the orgtbl-mode table to TAB separated material."
+ "Convert the `orgtbl-mode' TABLE to TAB separated material."
(orgtbl-to-generic table (org-combine-plists '(:sep "\t") params)))
;;;###autoload
(defun orgtbl-to-csv (table params)
- "Convert the orgtbl-mode table to CSV material.
+ "Convert the `orgtbl-mode' TABLE to CSV material.
This does take care of the proper quoting of fields with comma or quotes."
(orgtbl-to-generic table
(org-combine-plists '(:sep "," :fmt org-quote-csv-field)
@@ -5965,7 +5965,7 @@ This does take care of the proper quoting of fields with
comma or quotes."
;;;###autoload
(defun orgtbl-to-latex (table params)
- "Convert the orgtbl-mode TABLE to LaTeX.
+ "Convert the `orgtbl-mode' TABLE to LaTeX.
TABLE is a list, each entry either the symbol `hline' for
a horizontal separator line, or a list of fields for that line.
@@ -5998,7 +5998,7 @@ supported. It is also possible to use the following ones:
;;;###autoload
(defun orgtbl-to-html (table params)
- "Convert the orgtbl-mode TABLE to HTML.
+ "Convert the `orgtbl-mode' TABLE to HTML.
TABLE is a list, each entry either the symbol `hline' for
a horizontal separator line, or a list of fields for that line.
@@ -6029,7 +6029,7 @@ supported. It is also possible to use the following one:
;;;###autoload
(defun orgtbl-to-texinfo (table params)
- "Convert the orgtbl-mode TABLE to Texinfo.
+ "Convert the `orgtbl-mode' TABLE to Texinfo.
TABLE is a list, each entry either the symbol `hline' for
a horizontal separator line, or a list of fields for that line.
@@ -6060,7 +6060,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.
@@ -6075,7 +6075,7 @@ be set to provide ORGTBL directives for the generated
table."
(orgtbl-to-generic table (org-combine-plists params (list :backend 'org))))
(defun orgtbl-to-table.el (table params)
- "Convert the orgtbl-mode TABLE into a table.el table.
+ "Convert the `orgtbl-mode' TABLE into a table.el table.
TABLE is a list, each entry either the symbol `hline' for
a horizontal separator line, or a list of fields for that line.
PARAMS is a property list of parameters that can influence the
@@ -6089,7 +6089,7 @@ supported."
(replace-regexp-in-string "|-" "+-" (buffer-substring 1 (buffer-size))))))
(defun orgtbl-to-unicode (table params)
- "Convert the orgtbl-mode TABLE into a table with unicode characters.
+ "Convert the `orgtbl-mode' TABLE into a table with unicode characters.
TABLE is a list, each entry either the symbol `hline' for
a horizontal separator line, or a list of fields for that line.
@@ -6206,7 +6206,7 @@ which will prompt for the width."
(defun orgtbl-uc-draw-grid (value min max &optional width)
"Draw a bar in a table using block unicode characters.
-It is a variant of orgtbl-ascii-draw with Unicode block
+It is a variant of `orgtbl-ascii-draw' with Unicode block
characters, for a smooth display. Bars appear as grids (to the
extent the font allows)."
;; https://en.wikipedia.org/wiki/Block_Elements
@@ -6216,7 +6216,7 @@ extent the font allows)."
(defun orgtbl-uc-draw-cont (value min max &optional width)
"Draw a bar in a table using block unicode characters.
-It is a variant of orgtbl-ascii-draw with Unicode block
+It is a variant of `orgtbl-ascii-draw' with Unicode block
characters, for a smooth display. Bars are solid (to the extent
the font allows)."
(orgtbl-ascii-draw value min max width
diff --git a/lisp/org.el b/lisp/org.el
index 332188d..c265a34 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -3154,7 +3154,7 @@ it in the document property drawer. For example:
:CATEGORY: ELisp
:END:
-Other ways to define it is as an emacs file variable, for example
+Other ways to define it is as an Emacs file variable, for example
# -*- mode: org; org-category: \"ELisp\"
@@ -9561,7 +9561,7 @@ If an element cannot be made unique, an error is raised."
(mapcar (apply-partially #'concat (substring
key 0 1))
(split-string (substring key 1) ""
t)))))))
(if (or (not potential-key) (assoc potential-key menu-keys))
- (user-error "Could not make unique key for %s." key)
+ (user-error "Could not make unique key for `%s'" key)
(push (cons potential-key key) menu-keys))))
(mapcar #'car
(cl-sort menu-keys #'<
@@ -12506,12 +12506,12 @@ Inherited tags have the `inherited' text property."
(defun org-map-entries (func &optional match scope &rest skip)
"Call FUNC at each headline selected by MATCH in SCOPE.
-FUNC is a function or a lisp form. The function will be called without
+FUNC is a function or a Lisp form. The function will be called without
arguments, with the cursor positioned at the beginning of the headline.
The return values of all calls to the function will be collected and
returned as a list.
-The call to FUNC will be wrapped into a save-excursion form, so FUNC
+The call to FUNC will be wrapped into a `save-excursion' form, so FUNC
does not need to preserve point. After evaluation, the cursor will be
moved to the end of the line (presumably of the headline of the
processed entry) and search continues from there. Under some
@@ -13803,7 +13803,7 @@ If there is already a timestamp at the cursor, it is
replaced.
With two universal prefix arguments, insert an active timestamp
with the current time without prompting the user.
-When called from lisp, the timestamp is inactive if INACTIVE is
+When called from Lisp, the timestamp is inactive if INACTIVE is
non-nil."
(interactive "P")
(let* ((ts (cond
@@ -15376,9 +15376,9 @@ This function is useful in a setup where one tracks Org
files
with a version control system, to revert on one machine after pulling
changes from another. I believe the procedure must be like this:
-1. M-x org-save-all-org-buffers
+1. \\[org-save-all-org-buffers]
2. Pull changes from the other machine, resolve conflicts
-3. M-x org-revert-all-org-buffers"
+3. \\[org-revert-all-org-buffers]"
(interactive)
(unless (yes-or-no-p "Revert all Org buffers from their files? ")
(user-error "Abort"))
@@ -18039,7 +18039,7 @@ object (e.g., within a comment). In these case, you
need to use
Call `org-table-next-row' or `org-return', depending on context.
See the individual commands for more information.
-When inserting a newline, if `org-adapt-indentation' is `t':
+When inserting a newline, if `org-adapt-indentation' is t:
indent the line if `electric-indent-mode' is disabled, don't
indent it if it is enabled."
(interactive)
@@ -18209,7 +18209,7 @@ an argument, unconditionally call `org-insert-heading'."
(not (org-at-table-p))))
;; Define the Org mode menus
-(easy-menu-define org-org-menu org-mode-map "Org menu"
+(easy-menu-define org-org-menu org-mode-map "Org menu."
`("Org"
("Show/Hide"
["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
@@ -18394,7 +18394,7 @@ an argument, unconditionally call `org-insert-heading'."
["Reload Org (after update)" org-reload t]
["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x
!"])))
-(easy-menu-define org-tbl-menu org-mode-map "Org Table menu"
+(easy-menu-define org-tbl-menu org-mode-map "Org Table menu."
'("Table"
["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
["Next Field" org-cycle (org-at-table-p)]
@@ -19125,7 +19125,7 @@ Indentation is done according to the following rules:
Else, indent like parent's first line.
3. Otherwise, indent relatively to current level, if
- `org-adapt-indentation' is `t', or to left margin.
+ `org-adapt-indentation' is t, or to left margin.
- On a blank line at the end of an element, indent according to
the type of the element. More precisely
@@ -20090,7 +20090,7 @@ it has a `diary' type."
(defvar org--rds)
(defun org-reftex-citation ()
- "Use reftex-citation to insert a citation into the buffer.
+ "Use `reftex-citation' to insert a citation into the buffer.
This looks for a line like
#+BIBLIOGRAPHY: foo plain option:-d
@@ -20410,7 +20410,7 @@ interactive command with similar behavior."
(call-interactively command))))))
(defun org-yank-folding-would-swallow-text (beg end)
- "Would hide-subtree at BEG swallow any text after END?"
+ "Would `hide-subtree' at BEG swallow any text after END?"
(let (level)
(org-with-limited-levels
(save-excursion
diff --git a/lisp/ox-html.el b/lisp/ox-html.el
index bd6771a..7fb8fec 100644
--- a/lisp/ox-html.el
+++ b/lisp/ox-html.el
@@ -194,7 +194,7 @@
(defvar htmlize-buffer-places) ; from htmlize.el
(defvar org-html--pre/postamble-class "status"
- "CSS class used for pre/postamble")
+ "CSS class used for pre/postamble.")
(defconst org-html-doctype-alist
'(("html4-strict" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"
@@ -783,7 +783,7 @@ The function should return the string to be exported."
"The MathJax command to use when referencing equations.
This is a format control string that expects a single string argument
-specifying the label that is being referenced. The argument is
+specifying the label that is being referenced. The argument is
generated automatically on export.
The default is to wrap equations in parentheses (using \"\\eqref{%s}\)\".
@@ -874,7 +874,7 @@ link's path."
(defcustom org-html-htmlize-output-type 'inline-css
"Output type to be used by htmlize when formatting code snippets.
Choices are `css' to export the CSS selectors only,`inline-css'
-to export the CSS attribute values inline in the HTML or `nil' to
+to export the CSS attribute values inline in the HTML or nil to
export plain text. We use as default `inline-css', in order to
make the resulting HTML self-containing.
@@ -1133,7 +1133,7 @@ The choices are:
`html' HTML checkboxes
Note that only the ascii characters implement tri-state
-checkboxes. The other two use the `off' checkbox for `trans'.")
+checkboxes. The other two use the `off' checkbox for `trans'.")
(defcustom org-html-checkbox-type 'ascii
"The type of checkboxes to use for HTML export.
diff --git a/lisp/ox-koma-letter.el b/lisp/ox-koma-letter.el
index 55b66a8..3bd2f68 100644
--- a/lisp/ox-koma-letter.el
+++ b/lisp/ox-koma-letter.el
@@ -77,8 +77,8 @@
;;
;; The following variables works differently from the main LaTeX class
;; - AUTHOR: Default to user-full-name but may be disabled.
-;; (See also `org-koma-letter-author'),
-;; - EMAIL: Same as AUTHOR. (see also `org-koma-letter-email'),
+;; (See also `org-koma-letter-author'.)
+;; - EMAIL: Same as AUTHOR. (See also `org-koma-letter-email'.)
;;
;; FROM_LOGO uses LaTeX markup. FROM_LOGO provides the
;; "includegraphics" command to tell LaTeX where to find the logo.
@@ -478,7 +478,7 @@ e.g. \"title-subject:t\"."
"Header tags to be inserted in the letter after closing.")
(defconst org-koma-letter-special-tags-as-macro '(ps encl cc)
- "Header tags to be inserted as macros")
+ "Header tags to be inserted as macros.")
(defconst org-koma-letter-special-tags-after-letter '(after_letter)
"Header tags to be inserted after the letter.")
@@ -607,7 +607,7 @@ 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. `\\\\')."
(let ((str (org-trim string)))
(when (org-string-nw-p str)
(replace-regexp-in-string "\n" "\\\\\\\\\n" str))))
diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el
index 99076f8..a049284 100644
--- a/lisp/ox-latex.el
+++ b/lisp/ox-latex.el
@@ -297,7 +297,7 @@
("uk" "ukrainian")
("ur" "urdu")
("vi" "vietnamese"))
- "Alist between language code and corresponding Polyglossia option")
+ "Alist between language code and corresponding Polyglossia option.")
(defconst org-latex-table-matrix-macros '(("bordermatrix" . "\\cr")
("qbordermatrix" . "\\cr")
diff --git a/lisp/ox-man.el b/lisp/ox-man.el
index 27d2ded..bcce808 100644
--- a/lisp/ox-man.el
+++ b/lisp/ox-man.el
@@ -365,9 +365,9 @@ holding contextual information."
(defun org-man-drawer (_drawer contents _info)
"Transcode a DRAWER element from Org to Man.
- DRAWER holds the drawer information
- CONTENTS holds the contents of the block.
- INFO is a plist holding contextual information. "
+DRAWER holds the drawer information
+CONTENTS holds the contents of the block.
+INFO is a plist holding contextual information."
contents)
diff --git a/lisp/ox-odt.el b/lisp/ox-odt.el
index fa44304..945bc7d 100644
--- a/lisp/ox-odt.el
+++ b/lisp/ox-odt.el
@@ -251,7 +251,7 @@ Use `org-odt-add-automatic-style' to add update this
variable.'")
(defvar org-odt-object-counters nil
"Running counters for various OBJECT-TYPEs.
-Use this to generate automatic names and style-names. See
+Use this to generate automatic names and style-names. See
`org-odt-add-automatic-style'.")
(defvar org-odt-src-block-paragraph-format
@@ -277,8 +277,7 @@ according to the default face identified by the
`htmlfontify'.")
(defvar org-odt-default-image-sizes-alist
'(("as-char" . (5 . 0.4))
("paragraph" . (5 . 5)))
- "Hardcoded image dimensions one for each of the anchor
- methods.")
+ "Hardcoded image dimensions one for each of the anchor methods.")
;; A4 page size is 21.0 by 29.7 cms
;; The default page settings has 2cm margin on each of the sides. So
@@ -450,7 +449,7 @@ Valid values are one of:
4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
...))
-In case of option 1, an in-built styles.xml is used. See
+In case of option 1, an in-built styles.xml is used. See
`org-odt-styles-dir' for more information.
In case of option 3, the specified file is unzipped and the
@@ -2176,7 +2175,7 @@ SHORT-CAPTION are strings."
;;;; Links :: Inline Images
(defun org-odt--copy-image-file (path)
- "Return the internal name of the file"
+ "Return the internal name of the file."
(let* ((image-type (file-name-extension path))
(media-type (format "image/%s" image-type))
(target-dir "Images/")
@@ -2380,7 +2379,7 @@ used as a communication channel."
(concat equation "<text:tab/>" label))))))
(defun org-odt--copy-formula-file (src-file)
- "Return the internal name of the file"
+ "Return the internal name of the file."
(let* ((target-dir (format "Formula-%04d/"
(cl-incf org-odt-embedded-formulas-count)))
(target-file (concat target-dir "content.xml")))
diff --git a/lisp/ox-publish.el b/lisp/ox-publish.el
index 3b9666d..c25dd54 100644
--- a/lisp/ox-publish.el
+++ b/lisp/ox-publish.el
@@ -1270,7 +1270,7 @@ If FREE-CACHE, empty the cache."
org-publish-cache)
(defun org-publish-reset-cache ()
- "Empty org-publish-cache and reset it nil."
+ "Empty `org-publish-cache' and reset it nil."
(message "%s" "Resetting org-publish-cache")
(when (hash-table-p org-publish-cache)
(clrhash org-publish-cache))
diff --git a/lisp/ox-texinfo.el b/lisp/ox-texinfo.el
index 5d09cc2..3851f42 100644
--- a/lisp/ox-texinfo.el
+++ b/lisp/ox-texinfo.el
@@ -421,8 +421,8 @@ If two strings share the same prefix (e.g. \"ISO-8859-1\"
and
(defun org-texinfo--normalize-headlines (tree _backend info)
"Normalize headlines in TREE.
-BACK-END is the symbol specifying back-end used for export. INFO
-is a plist used as a communication channel.
+BACK-END is the symbol specifying back-end used for export.
+INFO is a plist used as a communication channel.
Make sure every headline in TREE contains a section, since those
are required to install a menu. Also put exactly one blank line
@@ -1606,7 +1606,7 @@ channel."
(defun org-texinfo-verse-block (_verse-block contents _info)
"Transcode a VERSE-BLOCK element from Org to Texinfo.
-CONTENTS is verse block contents. INFO is a plist holding
+CONTENTS is verse block contents. INFO is a plist holding
contextual information."
(format "@display\n%s@end display" contents))
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/org 51cdd6e: Various minor docfixes found by checkdoc,
ELPA Syncer <=