branch: externals-release/org
commit 2e36ac2ac18e6be3986c5fc534fe3d6837b0b20e
Merge: 1c3a46268f 9d29de23cf
Author: Kyle Meyer <k...@kyleam.com>
Commit: Kyle Meyer <k...@kyleam.com>
Merge single quote fixes from Emacs's master
This brings in ports of bbf389ea6de (Audit quoting the quote character
in doc strings, 2022-04-22), 2d71fd3b041 (Further doc string quoting
fixes, 2022-04-22), and b2bce107b15 (Further audits of single quotes
in Lisp doc strings, 2022-05-24) from Emacs's master branch, resolving
conflicts with 01b0fb14b (Backport from main: Escape single left
quotes in docstrings, 2022-07-24).
In all cases, take Emacs's side. There are two cases where I think
Org's version is preferable, org-babel-lua-read-string and
org-agenda-sorting-strategy. Don't keep those _on bugfix_ to avoid
conflicts when Emacs's emacs-28 branch is merged to its master branch.
When I merge bugfix to main, I'll keep Org's variant, so they'll
eventually make it to Emacs's tree, just not as part of the Org 9.5.x
to emacs-28 syncing.
---
lisp/ob-core.el | 2 +-
lisp/ob-julia.el | 8 ++++----
lisp/ob-lua.el | 2 +-
lisp/ob-table.el | 2 +-
lisp/org-agenda.el | 4 ++--
lisp/org-table.el | 2 +-
lisp/ox-html.el | 2 +-
7 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index 37155d4c58..04af84d2e4 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 be0110f48a..50a44bcf44 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 c8c28498e8..b6e78fb7fd 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 single quotes from around Lua string."
+ "Strip \\=' characters from around Lua string."
(org-unbracket-string "'" "'" string))
(provide 'ob-lua)
diff --git a/lisp/ob-table.el b/lisp/ob-table.el
index 0f6d41c5e1..f6729e0ece 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 4831c66b00..a43b083d53 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)
diff --git a/lisp/org-table.el b/lisp/org-table.el
index f41f6ffdff..c301bc6af1 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/ox-html.el b/lisp/ox-html.el
index 32c0699a6b..9cf9125aeb 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*"
