Browse Source

Backport from main: 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
01b0fb14bc
10 changed files with 16 additions and 16 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. 3 3
      lisp/org-agenda.el
  6. 1 1
      lisp/org-plot.el
  7. 1 1
      lisp/org-table.el
  8. 2 2
      lisp/org.el
  9. 1 1
      lisp/ox-html.el
  10. 1 1
      lisp/ox-publish.el

+ 1 - 1
lisp/ob-core.el

@@ -480,7 +480,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

+ 3 - 3
lisp/org-agenda.el

@@ -1615,7 +1615,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
@@ -4124,7 +4124,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)
@@ -7399,7 +7399,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")

+ 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

@@ -5465,7 +5465,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

@@ -1694,7 +1694,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)
 
 
@@ -3301,7 +3301,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

@@ -2909,7 +2909,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

@@ -839,7 +839,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'."