From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id 0IxcKHZXqGKxpQAAbAwnHQ (envelope-from ) for ; Tue, 14 Jun 2022 11:40:06 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id 6F37J3ZXqGJGZAEAauVa8A (envelope-from ) for ; Tue, 14 Jun 2022 11:40:06 +0200 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 2184F3FAA1 for ; Tue, 14 Jun 2022 11:40:06 +0200 (CEST) Received: from localhost ([::1]:57316 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1o131p-0004wE-7l for larch@yhetil.org; Tue, 14 Jun 2022 05:40:05 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47046) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1o12us-0006sn-4H for emacs-orgmode@gnu.org; Tue, 14 Jun 2022 05:32:56 -0400 Received: from mail-wr1-x436.google.com ([2a00:1450:4864:20::436]:46909) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1o12up-00079L-VH for emacs-orgmode@gnu.org; Tue, 14 Jun 2022 05:32:53 -0400 Received: by mail-wr1-x436.google.com with SMTP id u8so10383160wrm.13 for ; Tue, 14 Jun 2022 02:32:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:subject:gmane-reply-to-list:date:message-id:mime-version; bh=Z0gZuBwrdkThJOVRzPwW+4fNIrESCARacWuXTgpCibk=; b=iB3rQ9SWcs+5FT6wk+mdPRhwFZsyGGFctNUrq3XWYUd9ZL6msusq3KCaHYYpGe664A H+SGbPzOkz0Tjtsl+FcAlcxN1cDVsWZIaQuzYU51hN7KDHZ3aIG1Hvkv+fOhBLP62fiB IaM5RbvUto8B3ckX0x9g/Ew7ptAoHZIJk6xi6zGnhaMIQ3T+EUomHxorMiXOJLbq9ojp gJh2uNUYLklfD6j8dHSVAwPZLoMtl24A59fRa8kruRhG1Jk42c8ivFQWkzhdPiYipvuc 1KeXSXcK25cHuMHyveYWMM/g7pb55sRSu6iwVZvsvdlU4hCCdrsPEEnmMHfDIkwP3eoh J1ww== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:subject:gmane-reply-to-list:date :message-id:mime-version; bh=Z0gZuBwrdkThJOVRzPwW+4fNIrESCARacWuXTgpCibk=; b=USpWFE3DeeJUYzNw7dIBINevv6ehhNZ1sQqsmXTDtzZJw25GfKEtDXqd2XYesld8nU bbtKOOYQ7Ir4B/SmXXPypNVJ6ynuq05DfLfjSUjsKRABSPONij8bIcoitpNBfEx/n2t7 XHVwL9JY2RSNr0DbEaVtgi0+MRriQq4gqieY3p+jEvClCDJ8tBv09zZr63pISxhEdPZc eW/crX+sIC71GVG+wHm4A6oSSasd6BEAfRrUDeo9aWEscLMoFO5H23BovMj9T2XKp5GC Bz4ENv1oq69awlc5UvMGAGrLZ7obu9GBdJO74N1YIwZgvi830yIwS4B52wSICA+5Jm1Z /1vg== X-Gm-Message-State: AJIora+LU9lNhvlkNfA2Rp/t+7zh5HV8Z/5IYrzIMvq2OHjW996hV0nP pwcmBbiUG/KuLW1OsJrMHT+TIfh+vwk= X-Google-Smtp-Source: AGRyM1tKMyq+rnRS3BB8gpDUYnNkvLKN1t9wuPtLHAWFrIXshbqn8YTx/7ug9vaou8TlSKjbcDeBYA== X-Received: by 2002:a5d:504d:0:b0:210:24fd:add1 with SMTP id h13-20020a5d504d000000b0021024fdadd1mr3905017wrt.630.1655199169674; Tue, 14 Jun 2022 02:32:49 -0700 (PDT) Received: from rltb ([2a01:e0a:3f3:fb50:c43e:652:64b6:8eb]) by smtp.gmail.com with ESMTPSA id v22-20020a7bcb56000000b0039482d95ab7sm12338606wmj.24.2022.06.14.02.32.48 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 14 Jun 2022 02:32:48 -0700 (PDT) From: Robert Pluim To: emacs-orgmode@gnu.org Subject: [PATCH] Escape single left quotes in docstrings Gmane-Reply-To-List: yes Date: Tue, 14 Jun 2022 11:32:47 +0200 Message-ID: <87czfbzj28.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=2a00:1450:4864:20::436; envelope-from=rpluim@gmail.com; helo=mail-wr1-x436.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1655199606; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=Z0gZuBwrdkThJOVRzPwW+4fNIrESCARacWuXTgpCibk=; b=QbLRGKF6QjHFjR5qeiK4WCMz06LHU0IgAmdQw4398nrJIDxbqjz85/8gTfXfn5nPhStmHy JTQFWexkNbOplXEf4UVabuJ5uafVebclG6Ml4i9LogQ94b/m0NBD/n0uzzbinR390uCPfn 3rdcZu1thkygY7oPdox2E5D07TU8eT4T1i5Sr5ZCG6wwP7Oz4KS3jvmPjW1CBbOGIRXEhx +A6vhouLfyNJCDusOapzJxB9ln3imdc2Kaj3N/QHJh8GUElgPyxgpinfAzGGtDONPo8FQe EgSHN1hS25dsJgS1Hrg0hpv8MXmJ93T9p9Es1zvsoGyUq9AV11c7U/oiF/qAlQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1655199606; a=rsa-sha256; cv=none; b=k3ZJyVyC9NJtE5Cj+PbGTtUJaZw4YYTYJ0l2wShksuglOKlk5BMZ1HDxOW0hp/Tf5zc77e KwZBaeWWqP/ZrmFwTR4MCoiA42xyIBtFQj2re5+qQbwRWUPu/Rm0CBnWA6VBKfD5Qn815C xReZ1s4nbfLwnmWPC3BIJdadF7wpMnZVVrK4HjoSbT7v0X+hdxrBoihzQd/MhOYooQQ3u2 v2Q9dZw6hI4vNJjnqwEbhvR323PBsvyAazl6v5tRcSGRx2QIb/1r9oJkjYbtjmNQgygg/l iTwLqJ3NMUx7tlymMYobsAchUs4Flk7+Hg0fLozn6I6j++94vAL2i9t5dXpo4g== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=iB3rQ9SW; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -9.79 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=iB3rQ9SW; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 2184F3FAA1 X-Spam-Score: -9.79 X-Migadu-Scanner: scn0.migadu.com X-TUID: nm8iTF7k6Oue --=-=-= Content-Type: text/plain The emacs-29 byte compiler now complains about unescaped single left quote. Patch attached. Robert -- --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Escape-single-left-quotes-in-docstrings.patch >From d86ba4e5522a33f6960207327f6a84b58caa3d04 Mon Sep 17 00:00:00 2001 From: Robert Pluim Date: Tue, 14 Jun 2022 11:29:12 +0200 Subject: [PATCH] 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/oc-basic.el | 2 +- lisp/org-agenda.el | 6 +++--- lisp/org-fold-core.el | 8 ++++---- lisp/org-plot.el | 2 +- lisp/org-table.el | 2 +- lisp/org.el | 4 ++-- lisp/ox-html.el | 2 +- lisp/ox-publish.el | 2 +- 12 files changed, 21 insertions(+), 21 deletions(-) diff --git a/lisp/ob-core.el b/lisp/ob-core.el index 09d6adfe0..bfb263cfb 100644 --- a/lisp/ob-core.el +++ b/lisp/ob-core.el @@ -484,7 +484,7 @@ (defvar org-babel-default-header-args 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 abddca361..be0110f48 100644 --- a/lisp/ob-julia.el +++ b/lisp/ob-julia.el @@ -250,8 +250,8 @@ (defun org-babel-julia-evaluate (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 @@ (defun org-babel-julia-evaluate-external-process (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 48de0dbad..c8c28498e 100644 --- a/lisp/ob-lua.el +++ b/lisp/ob-lua.el @@ -395,7 +395,7 @@ (defun org-babel-lua-evaluate-session (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 2f092998d..0f6d41c5e 100644 --- a/lisp/ob-table.el +++ b/lisp/ob-table.el @@ -84,7 +84,7 @@ (defmacro org-sbe (source-block &rest variables) #+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/oc-basic.el b/lisp/oc-basic.el index 873986d07..a937f7513 100644 --- a/lisp/oc-basic.el +++ b/lisp/oc-basic.el @@ -329,7 +329,7 @@ (defun org-cite-basic--shorten-names (names) "Return a list of family names from a list of full NAMES. 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) (mapconcat (lambda (name) diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el index 0479a0e1f..2a8c10d48 100644 --- a/lisp/org-agenda.el +++ b/lisp/org-agenda.el @@ -1628,7 +1628,7 @@ (defcustom org-agenda-sorting-strategy 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 @@ -4138,7 +4138,7 @@ (defun org-agenda--mark-blocked-entry (entry) 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) @@ -7857,7 +7857,7 @@ (defun org-agenda-set-restriction-lock (&optional type) 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-fold-core.el b/lisp/org-fold-core.el index 939702c5c..ca4b6f05b 100644 --- a/lisp/org-fold-core.el +++ b/lisp/org-fold-core.el @@ -381,7 +381,7 @@ (defvar-local org-fold-core--specs '((org-fold-visible using isearch. - :isearch-open :: non-nil means that isearch can reveal text hidden 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 is automatically folded. - :rear-sticky :: non-nil means that text appended to the folded text @@ -708,7 +708,7 @@ (defun org-fold-core-remove-folding-spec (spec &optional buffer) SPEC must be a symbol. 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." (org-fold-core--check-spec spec) (when (eq buffer 'all) @@ -777,7 +777,7 @@ (defun org-fold-core-get-folding-spec (&optional spec-or-alias 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 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. 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)." @@ -1005,7 +1005,7 @@ (defvar org-fold-core--isearch-overlays nil 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. 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) "Hash table storing temporarily shown folds from isearch matches.") diff --git a/lisp/org-plot.el b/lisp/org-plot.el index f238bfbc6..c6bae4b62 100644 --- a/lisp/org-plot.el +++ b/lisp/org-plot.el @@ -280,7 +280,7 @@ (defun org--plot/item-frequencies (values &optional normalise) 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 b160dc97c..cbc2ce061 100644 --- a/lisp/org-table.el +++ b/lisp/org-table.el @@ -5466,7 +5466,7 @@ (defun org-table-to-lisp (&optional txt) (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 8e7aadde5..f3315252b 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -1509,7 +1509,7 @@ (defcustom org-ctrl-k-protect-subtree nil (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) @@ -3120,7 +3120,7 @@ (defcustom org-latex-to-html-convert-command nil %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 81ef002a0..32c0699a6 100644 --- a/lisp/ox-html.el +++ b/lisp/ox-html.el @@ -2909,7 +2909,7 @@ (defun org-html--latex-environment-numbered-p (element) (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 86166e94b..0744a6f00 100644 --- a/lisp/ox-publish.el +++ b/lisp/ox-publish.el @@ -839,7 +839,7 @@ (defun org-publish-find-property (file property project &optional backend) 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'." -- 2.35.1.607.gf01e51a7cf --=-=-=--