From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id SOqbCbR83WL3xgAAbAwnHQ (envelope-from ) for ; Sun, 24 Jul 2022 19:09:08 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id KKiZCbR83WKzHAEA9RJhRA (envelope-from ) for ; Sun, 24 Jul 2022 19:09:08 +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 E751C10B45 for ; Sun, 24 Jul 2022 19:09:06 +0200 (CEST) Received: from localhost ([::1]:44756 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oFf6H-0003OG-DE for larch@yhetil.org; Sun, 24 Jul 2022 13:09:05 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:60944) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oFf4s-0003LD-Ko for emacs-orgmode@gnu.org; Sun, 24 Jul 2022 13:07:38 -0400 Received: from zimbra.cs.ucla.edu ([131.179.128.68]:41616) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oFf4o-0005r4-Eb for emacs-orgmode@gnu.org; Sun, 24 Jul 2022 13:07:38 -0400 Received: from localhost (localhost [127.0.0.1]) by zimbra.cs.ucla.edu (Postfix) with ESMTP id 45C23160124 for ; Sun, 24 Jul 2022 10:07:31 -0700 (PDT) Received: from zimbra.cs.ucla.edu ([127.0.0.1]) by localhost (zimbra.cs.ucla.edu [127.0.0.1]) (amavisd-new, port 10032) with ESMTP id gJ-JmH5BCb0a; Sun, 24 Jul 2022 10:07:29 -0700 (PDT) Received: from localhost (localhost [127.0.0.1]) by zimbra.cs.ucla.edu (Postfix) with ESMTP id 662B6160120; Sun, 24 Jul 2022 10:07:29 -0700 (PDT) X-Virus-Scanned: amavisd-new at zimbra.cs.ucla.edu Received: from zimbra.cs.ucla.edu ([127.0.0.1]) by localhost (zimbra.cs.ucla.edu [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id q-vZQylBAsO3; Sun, 24 Jul 2022 10:07:29 -0700 (PDT) Received: from penguin.cs.ucla.edu (Penguin.CS.UCLA.EDU [131.179.64.200]) by zimbra.cs.ucla.edu (Postfix) with ESMTPSA id 2E728160112; Sun, 24 Jul 2022 10:07:29 -0700 (PDT) From: Paul Eggert To: emacs-orgmode@gnu.org Cc: Paul Eggert Subject: [PROPOSED-PATCH] Fix doc string quoting problems with ' Date: Sun, 24 Jul 2022 10:07:20 -0700 Message-Id: <20220724170720.46921-1-eggert@cs.ucla.edu> X-Mailer: git-send-email 2.37.1 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass client-ip=131.179.128.68; envelope-from=eggert@cs.ucla.edu; helo=zimbra.cs.ucla.edu X-Spam_score_int: -41 X-Spam_score: -4.2 X-Spam_bar: ---- X-Spam_report: (-4.2 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_MED=-2.3, 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=1658682547; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=hgtH12j4EvCLiPSkreGUc8PUFmuflY7T7cYlZQE6mbA=; b=AFUI3rRsjpgYFdqABA2pxxP3sUi7zfwa9xB4iQsFhbTedvrmmZb9c5KBpPwJunDVTgfzVf jbY3nDGrfEL3xV49S5eYXlfxeowp3FvSSwgp4J9xZHIcumI8ChITlMhfXJO0rqAKtpvPsO 5CGoDqEBASbgsj/DZ6Br0DVu0HXSSEDpN2j0CSEA0LkxSgV95TSIX+R90PB6X6MigNwyPq Gn4MM0oU38x5gwr7D4GZefrBGUD9F66tKW6PxuGTUrHmVy7nkynhuFY9Wo7gtLMkq9y2xa siTN8m0FwUnuV9bPM/UJSJocJ0eI1RoXWgU0kZtw9R4+Vrg0FmKifAl+TcS+9g== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1658682547; a=rsa-sha256; cv=none; b=DnlwqgknFfP8HIPG4MsVVNd70g2DdGpe87yaARSRXaqWwIzmMcxGSBcifv1oDY5B4XhytH bf42+MF9qloKfhsfNEd3AdqAj1xbCWyxu87NfLXMx2x/UHHZ8t/RyZmlrwVN0ND9gojPeW +KZ9GUvFUTndyewhbaTYsrU0I0HhQifuYj9N6dUST4csUiFvxHlTlFzBS1V+3Pet4Yd1Zn XNRAl4Tk5eduPBnH0O6JBIW3K001tSi3GV7nkw6AwJg7Y5bTLmrQMwhu5W2LZtaBPG9OES oTGGcYUpeZIQTLjSZEcl/FYM9lt6mabg7c4hu9Dvx2Z4Nl3M/Qn2M3/MY1Q4Kg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; 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: -1.43 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; 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: E751C10B45 X-Spam-Score: -1.43 X-Migadu-Scanner: scn1.migadu.com X-TUID: le5+g9q3zRxr The Emacs doc string convention is to document values as-is when that is clear, and surrounded by `single quotes' otherwise. For example, a doc string "(a b c)" stands for a list of symbols, and the doc string "`a'" stands for a single symbol. The doc string "\\=3D`a" is typically not correct for that single symbol, because that is equivalent to "(quote a)" and the typical intent is to talk about the symbol, not about the Lisp quoting construct. One needs "\\=3D`X" only when talking about something intended to be equivalent to "(quote X)", as in the doc string "(provide \\=3D'org-xyz)". --- lisp/ob-core.el | 6 +++--- lisp/ob-julia.el | 8 ++++---- lisp/ob-table.el | 4 ++-- lisp/org-agenda.el | 16 ++++++++-------- lisp/org-attach-git.el | 2 +- lisp/org-capture.el | 4 ++-- lisp/org-faces.el | 2 +- lisp/org-fold-core.el | 6 +++--- lisp/org-macs.el | 2 +- lisp/org-plot.el | 2 +- lisp/org-src.el | 2 +- lisp/org-table.el | 2 +- lisp/org.el | 2 +- lisp/ox.el | 12 ++++++------ 14 files changed, 35 insertions(+), 35 deletions(-) diff --git a/lisp/ob-core.el b/lisp/ob-core.el index ac9af5d24..945adf3a4 100644 --- a/lisp/ob-core.el +++ b/lisp/ob-core.el @@ -487,7 +487,7 @@ evaluates to a string. A 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. \\=3D'some-func), since org uses lexical binding. To +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))). =20 @@ -514,7 +514,7 @@ functionality is also supported for default header ar= guments by providing the header argument multiple times in the alist. For example: =20 -\\=3D'((:var . \"foo=3D\\\"bar\\\"\") + ((:var . \"foo=3D\\\"bar\\\"\") (:var . \"bar=3D\\\"foo\\\"\"))") =20 (put 'org-babel-default-header-args 'safe-local-variable @@ -2627,7 +2627,7 @@ in the buffer." If the `default-directory' is different from the containing file's directory then expand relative links. =20 -If the optional TYPE is passed as \\=3D'attachment and the path is a +If the optional TYPE is passed as `attachment' and the path is a descendant of the DEFAULT-DIRECTORY, the generated link will be specified as an an \"attachment:\" style link." (when (stringp result) diff --git a/lisp/ob-julia.el b/lisp/ob-julia.el index cb65b0310..7f25fafad 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 \\=3D'output then return standard output as a -string. If RESULT-TYPE equals \\=3D'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 \\=3D'output then return standard output as a -string. If RESULT-TYPE equals \\=3D'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-table.el b/lisp/ob-table.el index bafc81a1a..1c17db4cc 100644 --- a/lisp/ob-table.el +++ b/lisp/ob-table.el @@ -83,8 +83,8 @@ is the equivalent of the following source code block: results #+end_src =20 -NOTE: The quotation marks around the function name, -\\=3D'source-block\\=3D', are optional. +NOTE: The quotation marks around the function name +`source-block' are optional. =20 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 ace76729f..8e5f229e5 100644 --- a/lisp/org-agenda.el +++ b/lisp/org-agenda.el @@ -1646,7 +1646,7 @@ alpha-down Sort headlines alphabetically, r= eversed. =20 The different possibilities will be tried in sequence, and testing stops if one comparison returns a \"not-equal\". For example, the default - \\=3D'(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, k= eep @@ -2111,7 +2111,7 @@ the lower-case version of all tags." "Alist of characters and custom functions for bulk actions. For example, this value makes those two functions available: =20 - \\=3D'((?R set-category) + ((?R set-category) (?C bulk-cut)) =20 With selected entries in an agenda buffer, `B R' will call @@ -2123,7 +2123,7 @@ used for each call to your bulk custom function. T= he argument collecting function will be run once and should return a list of arguments to pass to the bulk function. For example: =20 - \\=3D'((?R set-category get-category)) + ((?R set-category get-category)) =20 Now, `B R' will call the custom `get-category' which would prompt the user once for a category. That category is then passed as an @@ -2732,7 +2732,7 @@ For example, if you have a custom agenda command \"= p\" and you want this command to be accessible only from plain text files, use this: =20 - \\=3D'((\"p\" ((in-file . \"\\\\.txt\\\\'\")))) + ((\"p\" ((in-file . \"\\\\.txt\\\\'\")))) =20 Here are the available contexts definitions: =20 @@ -2750,7 +2750,7 @@ accessible if there is at least one valid check. You can also bind a key to another agenda custom command depending on contextual rules. =20 - \\=3D'((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\")))) + ((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\")))) =20 Here it means: in .txt files, use \"p\" as the key for the agenda command otherwise associated with \"q\". (The command @@ -4156,7 +4156,7 @@ dimming them." ;FIXME: The arg is= n't used, actually! =20 If the header at `org-hd-marker' is blocked according to `org-entry-blocked-p', then if `org-agenda-dim-blocked-tasks' is -\\=3D'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) @@ -7877,7 +7877,7 @@ Argument ARG is the prefix argument." When in a restricted subtree, remove it. =20 The restriction will span over the entire file if TYPE is `file', -or if type is \\=3D'(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") @@ -11304,7 +11304,7 @@ argument: an entry from `org-agenda-get-day-entri= es'. FILTER can also be an alist with the car of each cell being either `headline' or `category'. For example: =20 - \\=3D'((headline \"IMPORTANT\") + ((headline \"IMPORTANT\") (category \"Work\")) =20 will only add headlines containing IMPORTANT or headlines diff --git a/lisp/org-attach-git.el b/lisp/org-attach-git.el index ddb2ee97a..c838686b3 100644 --- a/lisp/org-attach-git.el +++ b/lisp/org-attach-git.el @@ -43,7 +43,7 @@ =20 (defcustom org-attach-git-annex-auto-get 'ask "Confirmation preference for automatically getting annex files. -If \\=3D'ask, prompt using `y-or-n-p'. If t, always get. If nil, never= get." +If `ask', prompt using `y-or-n-p'. If t, always get. If nil, never get= ." :group 'org-attach :package-version '(Org . "9.0") :version "26.1" diff --git a/lisp/org-capture.el b/lisp/org-capture.el index 8748b7f84..f0a07b269 100644 --- a/lisp/org-capture.el +++ b/lisp/org-capture.el @@ -560,7 +560,7 @@ For example, if you have a capture template \"c\" and= you want this template to be accessible only from `message-mode' buffers, use this: =20 - \\=3D'((\"c\" ((in-mode . \"message-mode\")))) + ((\"c\" ((in-mode . \"message-mode\")))) =20 Here are the available contexts definitions: =20 @@ -578,7 +578,7 @@ accessible if there is at least one valid check. You can also bind a key to another capture template depending on contextual rules. =20 - \\=3D'((\"c\" \"d\" ((in-mode . \"message-mode\")))) + ((\"c\" \"d\" ((in-mode . \"message-mode\")))) =20 Here it means: in `message-mode buffers', use \"c\" as the key for the capture template otherwise associated with \"d\". diff --git a/lisp/org-faces.el b/lisp/org-faces.el index 3095dd5a4..a3db35f12 100644 --- a/lisp/org-faces.el +++ b/lisp/org-faces.el @@ -597,7 +597,7 @@ See also `org-agenda-deadline-faces'.") (0.0 . org-upcoming-distant-deadline)) "Faces for showing deadlines in the agenda. This is a list of cons cells. The cdr of each cell is a face to be used= , -and it can also just be like \\=3D'(:foreground \"yellow\"). +and it can also just be like (:foreground \"yellow\"). Each car is a fraction of the head-warning time that must have passed fo= r this the face in the cdr to be used for display. The numbers must be given in descending order. The head-warning time is normally taken diff --git a/lisp/org-fold-core.el b/lisp/org-fold-core.el index 3fcacb975..322840ed0 100644 --- a/lisp/org-fold-core.el +++ b/lisp/org-fold-core.el @@ -382,7 +382,7 @@ The following properties are known: using isearch. - :isearch-open :: non-nil means that isearch can reveal text hidden using this spec. This property does nothing - when \\=3D'isearch-ignore property is non-nil. + when `isearch-ignore' property is non-nil. - :front-sticky :: non-nil means that text prepended to the folded t= ext is automatically folded. - :rear-sticky :: non-nil means that text appended to the folded te= xt @@ -709,7 +709,7 @@ The folding spec properties will be set to PROPERTIES= (see SPEC must be a symbol. =20 BUFFER can be a buffer to remove SPEC in, nil to remove SPEC in current -buffer, or \\=3D'all to remove SPEC in all open `org-mode' buffers and a= ll +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) @@ -778,7 +778,7 @@ If SPEC-OR-ALIAS is a folding spec, only check the gi= ven folding spec." 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 \\=3D'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)." diff --git a/lisp/org-macs.el b/lisp/org-macs.el index 5931dd260..1dc0b7080 100644 --- a/lisp/org-macs.el +++ b/lisp/org-macs.el @@ -522,7 +522,7 @@ is selected, only the bare key is returned." For example, in this alist: =20 \(org-uniquify-alist \\=3D'((a 1) (b 2) (a 3))) - =3D> \\=3D'((a 1 3) (b 2)) + =3D> ((a 1 3) (b 2)) =20 merge (a 1) and (a 3) into (a 1 3). =20 diff --git a/lisp/org-plot.el b/lisp/org-plot.el index 3928da7d8..0fcedbc99 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 th= e number of values." collect (cons n (/ (length m) normaliser))))) =20 (defun org--plot/prime-factors (value) - "Return the prime decomposition of VALUE, e.g. for 12, \\=3D'(3 2 2)." + "Return the prime decomposition of VALUE, e.g. for 12, (3 2 2)." (let ((factors '(1)) (i 1)) (while (/=3D 1 value) (setq i (1+ i)) diff --git a/lisp/org-src.el b/lisp/org-src.el index b691817a7..767a8485c 100644 --- a/lisp/org-src.el +++ b/lisp/org-src.el @@ -234,7 +234,7 @@ For instance, the following value would color the bac= kground of emacs-lisp source blocks and python source blocks in purple and green, respectability. =20 - \\=3D'((\"emacs-lisp\" (:background \"#EEE2FF\")) + ((\"emacs-lisp\" (:background \"#EEE2FF\")) (\"python\" (:background \"#e5ffb8\")))" :group 'org-edit-structure :type '(repeat (list (string :tag "language") diff --git a/lisp/org-table.el b/lisp/org-table.el index e9d6c5a9f..a5a550812 100644 --- a/lisp/org-table.el +++ b/lisp/org-table.el @@ -5462,7 +5462,7 @@ The table is taken from the parameter TXT, or from = the buffer at point." (nreverse table))))) =20 (defun org-table-collapse-header (table &optional separator max-header-l= ines) - "Collapse the lines before \\=3D'hline into a single header. + "Collapse the lines before `hline' into a single header. =20 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 61a21115f..8454f776c 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -3457,7 +3457,7 @@ lines to the buffer: =20 (defcustom org-hidden-keywords nil "List of symbols corresponding to keywords to be hidden in the Org buf= fer. -For example, a value \\=3D'(title) for this list makes the document's ti= tle +For example, a value (title) for this list makes the document's title appear in the buffer without the initial \"#+TITLE:\" part." :group 'org-appearance :package-version '(Org . "9.5") diff --git a/lisp/ox.el b/lisp/ox.el index 8223940fb..5ba436743 100644 --- a/lisp/ox.el +++ b/lisp/ox.el @@ -872,7 +872,7 @@ This option can also be set with the OPTIONS keyword,= e.g., =20 This variable allows providing shortcuts for export snippets. =20 -For example, with a value of \\=3D'((\"h\" . \"html\")), the +For example, with a value of ((\"h\" . \"html\")), the HTML back-end will recognize the contents of \"@@h:@@\" as HTML code while every other back-end will ignore it." :group 'org-export-general @@ -1182,7 +1182,7 @@ keywords are understood: Menu entry for the export dispatcher. It should be a list like: =20 - \\=3D'(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU) + (KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU) =20 where : =20 @@ -1206,17 +1206,17 @@ keywords are understood: If it is an alist, associations should follow the pattern: =20 - \\=3D'(KEY DESCRIPTION ACTION) + (KEY DESCRIPTION ACTION) =20 where KEY, DESCRIPTION and ACTION are described above. =20 Valid values include: =20 - \\=3D'(?m \"My Special Back-end\" my-special-export-function) + (?m \"My Special Back-end\" my-special-export-function) =20 or =20 - \\=3D'(?l \"Export to LaTeX\" + (?l \"Export to LaTeX\" ((?p \"As PDF file\" org-latex-export-to-pdf) (?o \"As PDF file and open\" (lambda (a s v b) @@ -1227,7 +1227,7 @@ keywords are understood: or the following, which will be added to the previous sub-menu, =20 - \\=3D'(?l 1 + (?l 1 ((?B \"As TEX buffer (Beamer)\" org-beamer-export-as-latex) (?P \"As PDF file (Beamer)\" org-beamer-export-to-pdf))) =20 --=20 2.37.1