[elpa] externals-release/org 01b0fb14bc 2/4: Backport from main: Escape single left quotes in docstrings

[ELPA Syncer]

branch: externals-release/org
commit 01b0fb14bc9f4e5e253f09f85df2f932c1b96bcf
Author: Robert Pluim <rpluim@gmail.com>
Commit: Ihor Radchenko <yantar92@gmail.com>

    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.
---
 lisp/ob-core.el    | 2 +-
 lisp/ob-julia.el   | 8 ++++----
 lisp/ob-lua.el     | 2 +-
 lisp/ob-table.el   | 2 +-
 lisp/org-agenda.el | 6 +++---
 lisp/org-plot.el   | 2 +-
 lisp/org-table.el  | 2 +-
 lisp/org.el        | 4 ++--
 lisp/ox-html.el    | 2 +-
 lisp/ox-publish.el | 2 +-
 10 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index 23ef162a7f..37155d4c58 100644
--- a/lisp/ob-core.el
+++ b/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
 block is being evaluated (e.g. during execution or export), with
 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
 function within a closure (e.g. (lambda () (some-func))).
 
diff --git a/lisp/ob-julia.el b/lisp/ob-julia.el
index abddca3613..be0110f48a 100644
--- a/lisp/ob-julia.el
+++ b/lisp/ob-julia.el
@@ -250,8 +250,8 @@ end")
 (defun org-babel-julia-evaluate-external-process
     (body result-type result-params column-names-p)
   "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."
   (cl-case result-type
     (value
@@ -274,8 +274,8 @@ last statement in BODY, as elisp."
 (defun org-babel-julia-evaluate-session
     (session body result-type result-params column-names-p)
   "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."
   (cl-case result-type
     (value
diff --git a/lisp/ob-lua.el b/lisp/ob-lua.el
index 48de0dbad0..c8c28498e8 100644
--- a/lisp/ob-lua.el
+++ b/lisp/ob-lua.el
@@ -395,7 +395,7 @@ fd:close()"
         (org-babel-lua-table-or-string results)))))
 
 (defun org-babel-lua-read-string (string)
-  "Strip 's from around Lua string."
+  "Strip single quotes from around Lua string."
   (org-unbracket-string "'" "'" string))
 
 (provide 'ob-lua)
diff --git a/lisp/ob-table.el b/lisp/ob-table.el
index 2f092998d8..0f6d41c5e1 100644
--- a/lisp/ob-table.el
+++ b/lisp/ob-table.el
@@ -84,7 +84,7 @@ is the equivalent of the following source code block:
  #+end_src
 
 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
 references to source-code blocks, to force interpretation of a
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 71aac271f7..4831c66b00 100644
--- a/lisp/org-agenda.el
+++ b/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
 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,
 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
@@ -4124,7 +4124,7 @@ dimming them."                   ;FIXME: The arg isn't 
used, actually!
 
 If the header at `org-hd-marker' is blocked according to
 `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
 to t."
   (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.
 
 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
 subtree."
   (interactive "P")
diff --git a/lisp/org-plot.el b/lisp/org-plot.el
index 4183b2af65..7958ffd58d 100644
--- a/lisp/org-plot.el
+++ b/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)))))
 
 (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))
     (while (/= 1 value)
       (setq i (1+ i))
diff --git a/lisp/org-table.el b/lisp/org-table.el
index 860fd6e560..f41f6ffdff 100644
--- a/lisp/org-table.el
+++ b/lisp/org-table.el
@@ -5465,7 +5465,7 @@ The table is taken from the parameter TXT, or from the 
buffer at point."
         (nreverse table)))))
 
 (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 leading lines before the first `hline' symbol are considered
diff --git a/lisp/org.el b/lisp/org.el
index 06af12339e..a6155c1382 100644
--- a/lisp/org.el
+++ b/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)))
 
 (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
   :type 'boolean)
 
@@ -3301,7 +3301,7 @@ Replace format-specifiers in the command as noted below 
and use
 %i:     The LaTeX fragment to be converted.
 
 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
   :package-version '(Org . "9.4")
   :type '(choice
diff --git a/lisp/ox-html.el b/lisp/ox-html.el
index 81ef002a05..32c0699a6b 100644
--- a/lisp/ox-html.el
+++ b/lisp/ox-html.el
@@ -2909,7 +2909,7 @@ Starred and \"displaymath\" environments are not 
numbered."
 
 (defun org-html--unlabel-latex-environment (latex-frag)
   "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
    "\\`[ \t]*\\\\begin{\\([^*]+?\\)}"
    "\\1*"
diff --git a/lisp/ox-publish.el b/lisp/ox-publish.el
index 636bd0d2ae..51e2352b4e 100644
--- a/lisp/ox-publish.el
+++ b/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
 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
 PROPERTY, i.e. \"behavior\" parameter from `org-export-options-alist'."