Browse Source

Escape single left quotes in docstrings

* lisp/ob-core.el (org-babel-default-header-args):
* lisp/ob-julia.el (org-babel-julia-evaluate-external-process):
(org-babel-julia-evaluate-session):
* lisp/ob-lua.el (org-babel-lua-read-string):
* lisp/ob-table.el (org-sbe):
* lisp/oc-basic.el (org-cite-basic--shorten-names):
* lisp/org-agenda.el (org-agenda-sorting-strategy):
(org-agenda--mark-blocked-entry):
(org-agenda-set-restriction-lock):
* lisp/org-fold-core.el (org-fold-core--specs):
(org-fold-core-remove-folding-spec):
(org-fold-core-get-folding-spec):
(org-fold-core--isearch-overlays):
* lisp/org-plot.el (org--plot/prime-factors):
* lisp/org-table.el (org-table-collapse-header):
* lisp/org.el (org-special-ctrl-o):
(org-latex-to-html-convert-command):
* lisp/ox-html.el (org-html--unlabel-latex-environment):
* lisp/ox-publish.el (org-publish-find-property):
Use \\=' when there's a need for a single left quote in a docstring.

The emacs-29 byte compiler complains about such usage.
Robert Pluim 2 years ago
parent
commit
e9da29b6fa
12 changed files with 21 additions and 21 deletions
  1. 1 1
      lisp/ob-core.el
  2. 4 4
      lisp/ob-julia.el
  3. 1 1
      lisp/ob-lua.el
  4. 1 1
      lisp/ob-table.el
  5. 1 1
      lisp/oc-basic.el
  6. 3 3
      lisp/org-agenda.el
  7. 4 4
      lisp/org-fold-core.el
  8. 1 1
      lisp/org-plot.el
  9. 1 1
      lisp/org-table.el
  10. 2 2
      lisp/org.el
  11. 1 1
      lisp/ox-html.el
  12. 1 1
      lisp/ox-publish.el

+ 1 - 1
lisp/ob-core.el

@@ -485,7 +485,7 @@ value.  The value can either be a string or a closure that
 evaluates to a string.  The closure is evaluated when the source
 evaluates to a string.  The closure is evaluated when the source
 block is being evaluated (e.g. during execution or export), with
 block is being evaluated (e.g. during execution or export), with
 point at the source block.  It is not possible to use an
 point at the source block.  It is not possible to use an
-arbitrary function symbol (e.g. 'some-func), since org uses
+arbitrary function symbol (e.g. \\='some-func), since org uses
 lexical binding.  To achieve the same functionality, call the
 lexical binding.  To achieve the same functionality, call the
 function within a closure (e.g. (lambda () (some-func))).
 function within a closure (e.g. (lambda () (some-func))).
 
 

+ 4 - 4
lisp/ob-julia.el

@@ -250,8 +250,8 @@ end")
 (defun org-babel-julia-evaluate-external-process
 (defun org-babel-julia-evaluate-external-process
     (body result-type result-params column-names-p)
     (body result-type result-params column-names-p)
   "Evaluate BODY in external julia process.
   "Evaluate BODY in external julia process.
-If RESULT-TYPE equals 'output then return standard output as a
-string.  If RESULT-TYPE equals 'value then return the value of the
+If RESULT-TYPE equals \\='output then return standard output as a
+string.  If RESULT-TYPE equals \\='value then return the value of the
 last statement in BODY, as elisp."
 last statement in BODY, as elisp."
   (cl-case result-type
   (cl-case result-type
     (value
     (value
@@ -274,8 +274,8 @@ last statement in BODY, as elisp."
 (defun org-babel-julia-evaluate-session
 (defun org-babel-julia-evaluate-session
     (session body result-type result-params column-names-p)
     (session body result-type result-params column-names-p)
   "Evaluate BODY in SESSION.
   "Evaluate BODY in SESSION.
-If RESULT-TYPE equals 'output then return standard output as a
-string.  If RESULT-TYPE equals 'value then return the value of the
+If RESULT-TYPE equals \\='output then return standard output as a
+string.  If RESULT-TYPE equals \\='value then return the value of the
 last statement in BODY, as elisp."
 last statement in BODY, as elisp."
   (cl-case result-type
   (cl-case result-type
     (value
     (value

+ 1 - 1
lisp/ob-lua.el

@@ -395,7 +395,7 @@ fd:close()"
         (org-babel-lua-table-or-string results)))))
         (org-babel-lua-table-or-string results)))))
 
 
 (defun org-babel-lua-read-string (string)
 (defun org-babel-lua-read-string (string)
-  "Strip 's from around Lua string."
+  "Strip single quotes from around Lua string."
   (org-unbracket-string "'" "'" string))
   (org-unbracket-string "'" "'" string))
 
 
 (provide 'ob-lua)
 (provide 'ob-lua)

+ 1 - 1
lisp/ob-table.el

@@ -84,7 +84,7 @@ is the equivalent of the following source code block:
  #+end_src
  #+end_src
 
 
 NOTE: The quotation marks around the function name,
 NOTE: The quotation marks around the function name,
-'source-block', are optional.
+\\='source-block\\=', are optional.
 
 
 NOTE: By default, string variable names are interpreted as
 NOTE: By default, string variable names are interpreted as
 references to source-code blocks, to force interpretation of a
 references to source-code blocks, to force interpretation of a

+ 1 - 1
lisp/oc-basic.el

@@ -329,7 +329,7 @@ non-nil."
   "Return a list of family names from a list of full NAMES.
   "Return a list of family names from a list of full NAMES.
 
 
 To better accomomodate corporate names, this will only shorten
 To better accomomodate corporate names, this will only shorten
-personal names of the form 'family, given'."
+personal names of the form \"family, given\"."
   (when (stringp names)
   (when (stringp names)
     (mapconcat
     (mapconcat
      (lambda (name)
      (lambda (name)

+ 3 - 3
lisp/org-agenda.el

@@ -1628,7 +1628,7 @@ alpha-down         Sort headlines alphabetically, reversed.
 
 
 The different possibilities will be tried in sequence, and testing stops
 The different possibilities will be tried in sequence, and testing stops
 if one comparison returns a \"not-equal\".  For example, the default
 if one comparison returns a \"not-equal\".  For example, the default
-    '(time-up category-keep priority-down)
+    \\='(time-up category-keep priority-down)
 means: Pull out all entries having a specified time of day and sort them,
 means: Pull out all entries having a specified time of day and sort them,
 in order to make a time schedule for the current day the first thing in the
 in order to make a time schedule for the current day the first thing in the
 agenda listing for the day.  Of the entries without a time indication, keep
 agenda listing for the day.  Of the entries without a time indication, keep
@@ -4138,7 +4138,7 @@ dimming them."                   ;FIXME: The arg isn't used, actually!
 
 
 If the header at `org-hd-marker' is blocked according to
 If the header at `org-hd-marker' is blocked according to
 `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
 `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is
-'invisible and the header is not blocked by checkboxes, set the
+\\='invisible and the header is not blocked by checkboxes, set the
 text property `org-todo-blocked' to `invisible', otherwise set it
 text property `org-todo-blocked' to `invisible', otherwise set it
 to t."
 to t."
   (when (get-text-property 0 'todo-state entry)
   (when (get-text-property 0 'todo-state entry)
@@ -7857,7 +7857,7 @@ Argument ARG is the prefix argument."
 When in a restricted subtree, remove it.
 When in a restricted subtree, remove it.
 
 
 The restriction will span over the entire file if TYPE is `file',
 The restriction will span over the entire file if TYPE is `file',
-or if type is '(4), or if the cursor is before the first headline
+or if type is \\='(4), or if the cursor is before the first headline
 in the file.  Otherwise, only apply the restriction to the current
 in the file.  Otherwise, only apply the restriction to the current
 subtree."
 subtree."
   (interactive "P")
   (interactive "P")

+ 4 - 4
lisp/org-fold-core.el

@@ -381,7 +381,7 @@ The following properties are known:
                       using isearch.
                       using isearch.
 - :isearch-open     :: non-nil means that isearch can reveal text hidden
 - :isearch-open     :: non-nil means that isearch can reveal text hidden
                       using this spec.  This property does nothing
                       using this spec.  This property does nothing
-                      when 'isearch-ignore property is non-nil.
+                      when \\='isearch-ignore property is non-nil.
 - :front-sticky     :: non-nil means that text prepended to the folded text
 - :front-sticky     :: non-nil means that text prepended to the folded text
                       is automatically folded.
                       is automatically folded.
 - :rear-sticky      :: non-nil means that text appended to the folded text
 - :rear-sticky      :: non-nil means that text appended to the folded text
@@ -708,7 +708,7 @@ The folding spec properties will be set to PROPERTIES (see
 SPEC must be a symbol.
 SPEC must be a symbol.
 
 
 BUFFER can be a buffer to remove SPEC in, nil to remove SPEC in current
 BUFFER can be a buffer to remove SPEC in, nil to remove SPEC in current
-buffer, or 'all to remove SPEC in all open `org-mode' buffers and all
+buffer, or \\='all to remove SPEC in all open `org-mode' buffers and all
 future org buffers."
 future org buffers."
   (org-fold-core--check-spec spec)
   (org-fold-core--check-spec spec)
   (when (eq buffer 'all)
   (when (eq buffer 'all)
@@ -777,7 +777,7 @@ If SPEC-OR-ALIAS is a folding spec, only check the given folding spec."
 Return nil if there is no folding at point or POM.
 Return nil if there is no folding at point or POM.
 If SPEC-OR-ALIAS is nil, return a folding spec with highest priority
 If SPEC-OR-ALIAS is nil, return a folding spec with highest priority
 among present at `point' or POM.
 among present at `point' or POM.
-If SPEC-OR-ALIAS is 'all, return the list of all present folding
+If SPEC-OR-ALIAS is \\='all, return the list of all present folding
 specs.
 specs.
 If SPEC-OR-ALIAS is a valid folding spec or a spec alias, return the
 If SPEC-OR-ALIAS is a valid folding spec or a spec alias, return the
 corresponding folding spec (if the text is folded using that spec)."
 corresponding folding spec (if the text is folded using that spec)."
@@ -1005,7 +1005,7 @@ If SPEC-OR-ALIAS is omitted and FLAG is nil, unfold everything in the region."
 This is used to allow searching in regions hidden via text properties.
 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.
 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'
 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)
 (defvar-local org-fold-core--isearch-local-regions (make-hash-table :test 'equal)
   "Hash table storing temporarily shown folds from isearch matches.")
   "Hash table storing temporarily shown folds from isearch matches.")

+ 1 - 1
lisp/org-plot.el

@@ -280,7 +280,7 @@ When NORMALISE is non-nil, the count is divided by the number of values."
 	     collect (cons n (/ (length m) normaliser)))))
 	     collect (cons n (/ (length m) normaliser)))))
 
 
 (defun org--plot/prime-factors (value)
 (defun org--plot/prime-factors (value)
-  "Return the prime decomposition of VALUE, e.g. for 12, '(3 2 2)."
+  "Return the prime decomposition of VALUE, e.g. for 12, \\='(3 2 2)."
   (let ((factors '(1)) (i 1))
   (let ((factors '(1)) (i 1))
     (while (/= 1 value)
     (while (/= 1 value)
       (setq i (1+ i))
       (setq i (1+ i))

+ 1 - 1
lisp/org-table.el

@@ -5466,7 +5466,7 @@ The table is taken from the parameter TXT, or from the buffer at point."
         (nreverse table)))))
         (nreverse table)))))
 
 
 (defun org-table-collapse-header (table &optional separator max-header-lines)
 (defun org-table-collapse-header (table &optional separator max-header-lines)
-  "Collapse the lines before 'hline into a single header.
+  "Collapse the lines before \\='hline into a single header.
 
 
 The given TABLE is a list of lists as returned by `org-table-to-lisp'.
 The given TABLE is a list of lists as returned by `org-table-to-lisp'.
 The leading lines before the first `hline' symbol are considered
 The leading lines before the first `hline' symbol are considered

+ 2 - 2
lisp/org.el

@@ -1510,7 +1510,7 @@ OK to kill that hidden subtree.  When nil, kill without remorse."
 	  (const :tag "Never kill a hidden subtree with C-k" error)))
 	  (const :tag "Never kill a hidden subtree with C-k" error)))
 
 
 (defcustom org-special-ctrl-o t
 (defcustom org-special-ctrl-o t
-  "Non-nil means, make `C-o' insert a row in tables."
+  "Non-nil means, make `open-line' (\\[open-line]) insert a row in tables."
   :group 'org-edit-structure
   :group 'org-edit-structure
   :type 'boolean)
   :type 'boolean)
 
 
@@ -3120,7 +3120,7 @@ Replace format-specifiers in the command as noted below and use
 %i:     The LaTeX fragment to be converted.
 %i:     The LaTeX fragment to be converted.
 
 
 For example, this could be used with LaTeXML as
 For example, this could be used with LaTeXML as
-\"latexmlc 'literal:%i' --profile=math --preload=siunitx.sty 2>/dev/null\"."
+\"latexmlc \\='literal:%i\\=' --profile=math --preload=siunitx.sty 2>/dev/null\"."
   :group 'org-latex
   :group 'org-latex
   :package-version '(Org . "9.4")
   :package-version '(Org . "9.4")
   :type '(choice
   :type '(choice

+ 1 - 1
lisp/ox-html.el

@@ -2912,7 +2912,7 @@ Starred and \"displaymath\" environments are not numbered."
 
 
 (defun org-html--unlabel-latex-environment (latex-frag)
 (defun org-html--unlabel-latex-environment (latex-frag)
   "Change environment in LATEX-FRAG string to an unnumbered one.
   "Change environment in LATEX-FRAG string to an unnumbered one.
-For instance, change an 'equation' environment to 'equation*'."
+For instance, change an \\='equation\\=' environment to \\='equation*\\='."
   (replace-regexp-in-string
   (replace-regexp-in-string
    "\\`[ \t]*\\\\begin{\\([^*]+?\\)}"
    "\\`[ \t]*\\\\begin{\\([^*]+?\\)}"
    "\\1*"
    "\\1*"

+ 1 - 1
lisp/ox-publish.el

@@ -842,7 +842,7 @@ in `org-export-options-alist' or in export back-ends.  In the
 latter case, optional argument BACKEND has to be set to the
 latter case, optional argument BACKEND has to be set to the
 back-end where the option is defined, e.g.,
 back-end where the option is defined, e.g.,
 
 
-  (org-publish-find-property file :subtitle 'latex)
+  (org-publish-find-property file :subtitle \\='latex)
 
 
 Return value may be a string or a list, depending on the type of
 Return value may be a string or a list, depending on the type of
 PROPERTY, i.e. \"behavior\" parameter from `org-export-options-alist'."
 PROPERTY, i.e. \"behavior\" parameter from `org-export-options-alist'."