From unknown Fri Aug 15 03:57:20 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#50903 <50903@debbugs.gnu.org> To: bug#50903 <50903@debbugs.gnu.org> Subject: Status: Checkdoc recommendation for docstring subsitutions is inconsistent with other documentation Reply-To: bug#50903 <50903@debbugs.gnu.org> Date: Fri, 15 Aug 2025 10:57:20 +0000 retitle 50903 Checkdoc recommendation for docstring subsitutions is inconsi= stent with other documentation reassign 50903 emacs submitter 50903 Nikolay Kudryavtsev severity 50903 normal thanks From debbugs-submit-bounces@debbugs.gnu.org Wed Sep 29 15:46:25 2021 Received: (at submit) by debbugs.gnu.org; 29 Sep 2021 19:46:25 +0000 Received: from localhost ([127.0.0.1]:50316 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVfX7-00052W-0L for submit@debbugs.gnu.org; Wed, 29 Sep 2021 15:46:25 -0400 Received: from lists.gnu.org ([209.51.188.17]:50194) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVfX5-00052N-0s for submit@debbugs.gnu.org; Wed, 29 Sep 2021 15:46:23 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:47376) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mVfX3-00007n-Br for bug-gnu-emacs@gnu.org; Wed, 29 Sep 2021 15:46:21 -0400 Received: from mail-lf1-x130.google.com ([2a00:1450:4864:20::130]:45960) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mVfX1-00079B-HJ for bug-gnu-emacs@gnu.org; Wed, 29 Sep 2021 15:46:21 -0400 Received: by mail-lf1-x130.google.com with SMTP id u18so15354566lfd.12 for ; Wed, 29 Sep 2021 12:46:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:subject:message-id:date:user-agent:mime-version :content-language; bh=ZCbDiIX4h9/94HVhGhu8sEBSuZRpTYGm3mswJP2ajvg=; b=W84aQ5Ndo7z/r6k3oTwNLw972N0P0K2+GieNqESS8RiWlIeLTLUIy0Kibu9qBi1f7u 2il13OU/f0R/Ebhqjq2g3HjOKzZdS8dg3lhpQWvVdY78xS1Hv5xw7TRI49cew9AwM1Zz pkihlpSl2jfmzIWH1buVfCEtjSiQGHwb1Mf9i4RUWI1bgo/HnhSOD5tB0Gl9OV87LBeJ AX1cxAbzqjQj5P3w+gpPUFUcjaSFQz8wVcqwdkBCKZnMedGp6DIvbK+oYJKy3a1fy5E5 n/+6Hcy4H1h/MXnKOHPFKuB8rRJkFFxuDA4vW9G3tJNCJihaIZId8bDlws+EnDloAMOf Dfzg== 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:message-id:date:user-agent :mime-version:content-language; bh=ZCbDiIX4h9/94HVhGhu8sEBSuZRpTYGm3mswJP2ajvg=; b=WYWweQx/vHVKerriaM6ibaYOtR2JqLxtZwf0BYezvKxfabbGzF6ni7OZ1qOulK8xwX oboBITMAlAwePgPAzmyiADpG9O8DeRVWaUfknDJ1M0h0x5LAsYSasS8/qTUPj8gsL7ew tO3kRmravKDJDsp/qgXpRc1OFXt3vkHEd+s3ZQmBnXpXptdsHBjIdfEBIYlZAFzTk8hv H7DfmJmkNHaE7GDj9R9Gh9NDTJOIDZ/EsS2pwauLLeTPs5TAG9LscDa8KOFastLtMKeG 18COQmSRQL3ITmr05queJwIeJX841SFdu8n+rh8XyuUuZ7ZLItypXuP6am4hqj/BGZqP 0wbA== X-Gm-Message-State: AOAM531sgA6RafpnaxvLwV1U/A5XPl5e75kW+4rNf1xHM9MAul6VjNaZ kwEHbDccfZmJSdKTiEI4kpbU9yHzk9c= X-Google-Smtp-Source: ABdhPJxbLy83OXRr4sLj1GjjWhkSxK2iANN+cfLhisZ8Nkf/+uddmpFCR8BJqPQ0NlSEltxS9I5ZpQ== X-Received: by 2002:a05:6512:214e:: with SMTP id s14mr1538755lfr.588.1632944776929; Wed, 29 Sep 2021 12:46:16 -0700 (PDT) Received: from ?IPv6:2a02:2168:b115:9d00:5256:21d3:d9bf:ccde? ([2a02:2168:b115:9d00:5256:21d3:d9bf:ccde]) by smtp.gmail.com with ESMTPSA id g2sm92029lfe.266.2021.09.29.12.46.16 for (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Wed, 29 Sep 2021 12:46:16 -0700 (PDT) From: Nikolay Kudryavtsev X-Google-Original-From: Nikolay Kudryavtsev To: bug-gnu-emacs@gnu.org Subject: Checkdoc recommendation for docstring subsitutions is inconsistent with other documentation Message-ID: <70d5f8e1-0131-c0e2-1033-03911377e856@gmail.com> Date: Wed, 29 Sep 2021 22:46:14 +0300 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.14.0 MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="------------84E9C52A6F40CA61713E1F64" Content-Language: en-US Received-SPF: pass client-ip=2a00:1450:4864:20::130; envelope-from=nikolay.kudryavtsev@gmail.com; helo=mail-lf1-x130.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 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.3 (-) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -2.3 (--) This is a multi-part message in MIME format. --------------84E9C52A6F40CA61713E1F64 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 8bit I had a docstring containing "C-c". Checkdoc gave me this suggestion: "Keycode C-c embedded in doc string.  Use \\ & \\[function] instead" Ok, but how? The relevant page of Elisp reference is (info "(elisp) Keys in Documentation"). But there they're called ‘\’ and ‘\[COMMAND]’. So someone searching by the checkdoc names would never find them there. The docstring for substitute-command-keys is also consistent with the Elisp reference. A trivial patch is included, since Elisp reference names seem more reasonable. I'm not sure whether MAPVAR and COMMAND should be capitalized in the docstring, so someone else should decide on that. --------------84E9C52A6F40CA61713E1F64 Content-Type: text/plain; charset=UTF-8; name="0001-checkdoc-Docstring-substitution-consistent-with-othe.patch" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename*0="0001-checkdoc-Docstring-substitution-consistent-with-othe.pa"; filename*1="tch" RnJvbSA4NjE4ZTg2YWNkOTNhMGQ2ZmMwMmNjYjJkZTQ5M2MyYmUxYWM3OTVhIE1vbiBTZXAg MTcgMDA6MDA6MDAgMjAwMQpGcm9tOiBOaWtvbGF5IEt1ZHJ5YXZ0c2V2IDxuaWtvbGF5Lmt1 ZHJ5YXZ0c2V2QGdtYWlsLmNvbT4KRGF0ZTogV2VkLCAyOSBTZXAgMjAyMSAyMjozMzo0OSAr MDMwMApTdWJqZWN0OiBbUEFUQ0hdIGNoZWNrZG9jOiBEb2NzdHJpbmcgc3Vic3RpdHV0aW9u IGNvbnNpc3RlbnQgd2l0aCBvdGhlciBkb2NzLgoKKiBsaXNwL2VtYWNzLWxpc3AvY2hlY2tk b2MuZWwgKGNoZWNrZG9jLXRoaXMtc3RyaW5nLXZhbGlkLWVuZ2luZSk6CkluIGVycm9yIHRl eHQgcmV0dXJuICJNQVBWQVIiIGluc3RlYWQgb2YgImtleW1hcCIgYW5kICJDT01NQU5EIgpp bnN0ZWFkIG9mICJmdW5jdGlvbiIuCi0tLQogbGlzcC9lbWFjcy1saXNwL2NoZWNrZG9jLmVs IHwgNiArKystLS0KIDEgZmlsZSBjaGFuZ2VkLCAzIGluc2VydGlvbnMoKyksIDMgZGVsZXRp b25zKC0pCgpkaWZmIC0tZ2l0IGEvbGlzcC9lbWFjcy1saXNwL2NoZWNrZG9jLmVsIGIvbGlz cC9lbWFjcy1saXNwL2NoZWNrZG9jLmVsCmluZGV4IDVlYTJmNTllZTYuLjE2OTE4NzQ2Y2Eg MTAwNjQ0Ci0tLSBhL2xpc3AvZW1hY3MtbGlzcC9jaGVja2RvYy5lbAorKysgYi9saXNwL2Vt YWNzLWxpc3AvY2hlY2tkb2MuZWwKQEAgLTI1NCw3ICsyNTQsNyBAQCBjaGVja2RvYy1pc3Bl bGwtbGlzcC13b3JkcwogKGRlZmN1c3RvbSBjaGVja2RvYy1tYXgta2V5cmVmLWJlZm9yZS13 YXJuIG5pbAogICAiSWYgbm9uLW5pbCwgbnVtYmVyIG9mIFxcXFw9W2NvbW1hbmQtdG8ta2V5 c3Ryb2tlXSB0b2tlbnMgYWxsb3dlZCBpbiBhIGRvYyBzdHJpbmcuCiBBbnkgbW9yZSB0aGFu IHRoaXMgYW5kIGEgd2FybmluZyBpcyBnZW5lcmF0ZWQgc3VnZ2VzdGluZyB0aGF0IHRoZSBj b25zdHJ1Y3QKLVxcXFw9e2tleW1hcH0gYmUgdXNlZCBpbnN0ZWFkLiAgSWYgdGhlIHZhbHVl IGlzIG5pbCwgbmV2ZXIgd2Fybi4KK1xcXFw9e01BUFZBUn0gYmUgdXNlZCBpbnN0ZWFkLiAg SWYgdGhlIHZhbHVlIGlzIG5pbCwgbmV2ZXIgd2Fybi4KIAogSXQgdXNlZCB0byBub3QgYmUg cHJhY3RpY2FsIHRvIHVzZSBgXFxcXD1bLi4uXScgdmVyeSBtYW55IHRpbWVzLAogYmVjYXVz ZSBkaXNwbGF5IG9mIHRoZSBkb2N1bWVudGF0aW9uIHN0cmluZyB3b3VsZCBiZWNvbWUgc2xv dy4KQEAgLTE2MjYsNyArMTYyNiw3IEBAIGNoZWNrZG9jLXRoaXMtc3RyaW5nLXZhbGlkLWVu Z2luZQogCSAgICAgKGNoZWNrZG9jLWNyZWF0ZS1lcnJvcgogCSAgICAgIChjb25jYXQKIAkg ICAgICAgIktleWNvZGUgIiAobWF0Y2gtc3RyaW5nIDEpCi0JICAgICAgICIgZW1iZWRkZWQg aW4gZG9jIHN0cmluZy4gIFVzZSBcXFxcPGtleW1hcD4gJiBcXFxcW2Z1bmN0aW9uXSAiCisJ ICAgICAgICIgZW1iZWRkZWQgaW4gZG9jIHN0cmluZy4gIFVzZSBcXFxcPE1BUFZBUj4gJiBc XFxcW0NPTU1BTkRdICIKIAkgICAgICAgImluc3RlYWQiKQogCSAgICAgIChtYXRjaC1iZWdp bm5pbmcgMSkgKG1hdGNoLWVuZCAxKSB0KSkpKQogICAgICA7OyBPcHRpb25hbGx5IHdhcm4g YWJvdXQgdG9vIG1hbnkgY29tbWFuZCBzdWJzdGl0dXRpb25zLgpAQCAtMTYzNiw3ICsxNjM2 LDcgQEAgY2hlY2tkb2MtdGhpcy1zdHJpbmctdmFsaWQtZW5naW5lCiAgICAgICAgICAgICAg ICAgICAgICAgICAgICAgICAgICAgICAgKDErIGNoZWNrZG9jLW1heC1rZXlyZWYtYmVmb3Jl LXdhcm4pKQogICAgICAgICAgICAgICAgICAgKG5vdCAocmUtc2VhcmNoLWZvcndhcmQgIlxc XFxcXFxce1xcdyt9IiBlIHQpKSkKICAgICAgICAgICAgICAoY2hlY2tkb2MtY3JlYXRlLWVy cm9yCi0gICAgICAgICAgICAgICJUb28gbWFueSBvY2N1cnJlbmNlcyBvZiBcXFtmdW5jdGlv bl0uICBVc2UgXFx7a2V5bWFwfSBpbnN0ZWFkIgorICAgICAgICAgICAgICAiVG9vIG1hbnkg b2NjdXJyZW5jZXMgb2YgXFxbQ09NTUFORF0uICBVc2UgXFx7TUFQVkFSfSBpbnN0ZWFkIgog ICAgICAgICAgICAgICBzIChtYXJrZXItcG9zaXRpb24gZSkpKSkpCiAgICAgIDs7IEFtYmln dW91cyBxdW90ZWQgc3ltYm9sLiAgV2hlbiBhIHN5bWJvbCBpcyBib3RoIGJvdW5kIGFuZCBm Ym91bmQsCiAgICAgIDs7IGFuZCBpcyByZWZlcnJlZCB0byBpbiBkb2N1bWVudGF0aW9uLCBp dCBzaG91bGQgYmUgcHJlZml4ZWQgd2l0aAotLSAKMi4zMi4wLndpbmRvd3MuMQoK --------------84E9C52A6F40CA61713E1F64-- From debbugs-submit-bounces@debbugs.gnu.org Thu Sep 30 04:41:47 2021 Received: (at 50903) by debbugs.gnu.org; 30 Sep 2021 08:41:47 +0000 Received: from localhost ([127.0.0.1]:51425 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVrdT-0006am-BQ for submit@debbugs.gnu.org; Thu, 30 Sep 2021 04:41:47 -0400 Received: from eggs.gnu.org ([209.51.188.92]:47344) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVrdR-0006aa-UJ for 50903@debbugs.gnu.org; Thu, 30 Sep 2021 04:41:46 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:36252) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mVrdM-00082F-0L; Thu, 30 Sep 2021 04:41:40 -0400 Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:2050 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mVrdK-0000Ik-OX; Thu, 30 Sep 2021 04:41:39 -0400 Date: Thu, 30 Sep 2021 11:41:46 +0300 Message-Id: <83k0iyh2ut.fsf@gnu.org> From: Eli Zaretskii To: Nikolay Kudryavtsev In-Reply-To: <70d5f8e1-0131-c0e2-1033-03911377e856@gmail.com> (message from Nikolay Kudryavtsev on Wed, 29 Sep 2021 22:46:14 +0300) Subject: Re: bug#50903: Checkdoc recommendation for docstring subsitutions is inconsistent with other documentation References: <70d5f8e1-0131-c0e2-1033-03911377e856@gmail.com> MIME-version: 1.0 Content-type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 50903 Cc: 50903@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Nikolay Kudryavtsev > Date: Wed, 29 Sep 2021 22:46:14 +0300 > > I had a docstring containing "C-c". Checkdoc gave me this suggestion: > "Keycode C-c embedded in doc string.  Use \\ & \\[function] instead" > > Ok, but how? The relevant page of Elisp reference is (info "(elisp) Keys > in Documentation"). But there they're called ‘\’ and > ‘\[COMMAND]’. So someone searching by the checkdoc names would never > find them there. The docstring for substitute-command-keys is also > consistent with the Elisp reference. > > A trivial patch is included, since Elisp reference names seem more > reasonable. > > I'm not sure whether MAPVAR and COMMAND should be capitalized in the > docstring, so someone else should decide on that. They shouldn't be capitalized. They are capitalized in Info because that's what @var{..} produces in Info. But in HTML and PDF, the result is not capitalized, it is in italics instead. So these shoiuld not be capitalized in messages, either. Thanks. From debbugs-submit-bounces@debbugs.gnu.org Thu Sep 30 09:36:15 2021 Received: (at 50903) by debbugs.gnu.org; 30 Sep 2021 13:36:15 +0000 Received: from localhost ([127.0.0.1]:51764 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVwEQ-0007xA-QZ for submit@debbugs.gnu.org; Thu, 30 Sep 2021 09:36:15 -0400 Received: from mail-lf1-f48.google.com ([209.85.167.48]:35487) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVwEP-0007wq-9o for 50903@debbugs.gnu.org; Thu, 30 Sep 2021 09:36:14 -0400 Received: by mail-lf1-f48.google.com with SMTP id m3so25115364lfu.2 for <50903@debbugs.gnu.org>; Thu, 30 Sep 2021 06:36:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:subject:to:cc:references:message-id:date:user-agent :mime-version:in-reply-to:content-language; bh=fMA9NAoWhw4ZWJo9852W174UVgmDyfnmbguqtBew6ps=; b=ZegP8Z/xkv/0ROcaIzFSc640sbSJGUk/t29e3+vNFdgCX9jv8kYCvlGAkoGNeAhq8J frsqrtPBu7ojXEEYoY97/02U254O1QOFDxM53aYOIpkbyPlubfqKMNN4QzPgO4TEwEv/ iZKc9Zf5LK7JOzXNMqT5ugSPv15t+MguzWUjhNej8If3wuUDqsM0l/l05YG3DJArlNdv KN7sYxWz2b+wP4DGoy1rKv8harIxNyet122yp1RmDWhNp66DdXkafVIt0uiEGM3oVqFo w/UV+qFzj5npfD2M8zux+IIz3wTm0NLbkxHmhKGSQvJ8eLyilCXNmaSCsHVPGtImfwfv fDKw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:subject:to:cc:references:message-id:date :user-agent:mime-version:in-reply-to:content-language; bh=fMA9NAoWhw4ZWJo9852W174UVgmDyfnmbguqtBew6ps=; b=wV8c7SBuHQiixyk/h1ZIEIkNXwKtF9APIQPue2h+5rU8Mnl93IYcQ+UcCKkK9Y9Xa5 ExTwTWO07eV7ZhouMZ6o/tov3EK+0aJLrff/OZCI3csvY59QFNfPb03H73/Ye0f03Jac mRlZRuSYR/7AJWaBq/J0C+gCqSr8HfVraSRyix+EkU72gxAtCKJwzquZ50eUyQkl6uJo 3IXg1LV0l5YQ+pCFhdea68NcKew0bpQvELG5W012vvZrTHrGZDlZ2afBnEplFn9GBnz+ PqEcluDjTrUGs5xb420VLzHMGrMW7iY31dm/ZA1qBZt1quj2vkWq5PqUJUIWUyiHZxcO we1Q== X-Gm-Message-State: AOAM530wQSL0p38w4OM55X+4EYYyhDz8R1VCIeb8lTsJS+skF3osDAmj az/svGZThaQZCPNcXlZccs34754Ai5Y= X-Google-Smtp-Source: ABdhPJxZEmAMilyWvOFsD28MqluZZzNV//3+Zmw/7yEvMuaoWJCCUlMzFUWbL0Aa5uvt37oQBG8uNQ== X-Received: by 2002:a2e:140e:: with SMTP id u14mr5826313ljd.26.1633008960747; Thu, 30 Sep 2021 06:36:00 -0700 (PDT) Received: from ?IPv6:2a02:2168:b115:9d00:e785:1b9c:f247:a49d? ([2a02:2168:b115:9d00:e785:1b9c:f247:a49d]) by smtp.gmail.com with ESMTPSA id z19sm377621lfr.14.2021.09.30.06.36.00 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 30 Sep 2021 06:36:00 -0700 (PDT) From: Nikolay Kudryavtsev X-Google-Original-From: Nikolay Kudryavtsev Subject: Re: bug#50903: Checkdoc recommendation for docstring subsitutions is inconsistent with other documentation To: Eli Zaretskii References: <70d5f8e1-0131-c0e2-1033-03911377e856@gmail.com> <83k0iyh2ut.fsf@gnu.org> Message-ID: <1f246932-4526-5afd-c699-a87714c7dc64@gmail.com> Date: Thu, 30 Sep 2021 16:35:59 +0300 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.14.0 MIME-Version: 1.0 In-Reply-To: <83k0iyh2ut.fsf@gnu.org> Content-Type: multipart/mixed; boundary="------------2096600613CF42C06FF4E384" Content-Language: ru X-Spam-Score: -0.1 (/) X-Debbugs-Envelope-To: 50903 Cc: 50903@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.1 (-) This is a multi-part message in MIME format. --------------2096600613CF42C06FF4E384 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Roger. s/r-d the patch. --------------2096600613CF42C06FF4E384 Content-Type: text/plain; charset=UTF-8; name="0001-checkdoc-Docstring-substitution-consistent-with-othe.patch" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename*0="0001-checkdoc-Docstring-substitution-consistent-with-othe.pa"; filename*1="tch" RnJvbSA4NjE4ZTg2YWNkOTNhMGQ2ZmMwMmNjYjJkZTQ5M2MyYmUxYWM3OTVhIE1vbiBTZXAg MTcgMDA6MDA6MDAgMjAwMQpGcm9tOiBOaWtvbGF5IEt1ZHJ5YXZ0c2V2IDxuaWtvbGF5Lmt1 ZHJ5YXZ0c2V2QGdtYWlsLmNvbT4KRGF0ZTogV2VkLCAyOSBTZXAgMjAyMSAyMjozMzo0OSAr MDMwMApTdWJqZWN0OiBbUEFUQ0hdIGNoZWNrZG9jOiBEb2NzdHJpbmcgc3Vic3RpdHV0aW9u IGNvbnNpc3RlbnQgd2l0aCBvdGhlciBkb2NzLgoKKiBsaXNwL2VtYWNzLWxpc3AvY2hlY2tk b2MuZWwgKGNoZWNrZG9jLXRoaXMtc3RyaW5nLXZhbGlkLWVuZ2luZSk6CkluIGVycm9yIHRl eHQgcmV0dXJuICJtYXB2YXIiIGluc3RlYWQgb2YgImtleW1hcCIgYW5kICJjb21tYW5kIgpp bnN0ZWFkIG9mICJmdW5jdGlvbiIuCi0tLQogbGlzcC9lbWFjcy1saXNwL2NoZWNrZG9jLmVs IHwgNiArKystLS0KIDEgZmlsZSBjaGFuZ2VkLCAzIGluc2VydGlvbnMoKyksIDMgZGVsZXRp b25zKC0pCgpkaWZmIC0tZ2l0IGEvbGlzcC9lbWFjcy1saXNwL2NoZWNrZG9jLmVsIGIvbGlz cC9lbWFjcy1saXNwL2NoZWNrZG9jLmVsCmluZGV4IDVlYTJmNTllZTYuLjE2OTE4NzQ2Y2Eg MTAwNjQ0Ci0tLSBhL2xpc3AvZW1hY3MtbGlzcC9jaGVja2RvYy5lbAorKysgYi9saXNwL2Vt YWNzLWxpc3AvY2hlY2tkb2MuZWwKQEAgLTI1NCw3ICsyNTQsNyBAQCBjaGVja2RvYy1pc3Bl bGwtbGlzcC13b3JkcwogKGRlZmN1c3RvbSBjaGVja2RvYy1tYXgta2V5cmVmLWJlZm9yZS13 YXJuIG5pbAogICAiSWYgbm9uLW5pbCwgbnVtYmVyIG9mIFxcXFw9W2NvbW1hbmQtdG8ta2V5 c3Ryb2tlXSB0b2tlbnMgYWxsb3dlZCBpbiBhIGRvYyBzdHJpbmcuCiBBbnkgbW9yZSB0aGFu IHRoaXMgYW5kIGEgd2FybmluZyBpcyBnZW5lcmF0ZWQgc3VnZ2VzdGluZyB0aGF0IHRoZSBj b25zdHJ1Y3QKLVxcXFw9e2tleW1hcH0gYmUgdXNlZCBpbnN0ZWFkLiAgSWYgdGhlIHZhbHVl IGlzIG5pbCwgbmV2ZXIgd2Fybi4KK1xcXFw9e21hcHZhcn0gYmUgdXNlZCBpbnN0ZWFkLiAg SWYgdGhlIHZhbHVlIGlzIG5pbCwgbmV2ZXIgd2Fybi4KCiBJdCB1c2VkIHRvIG5vdCBiZSBw cmFjdGljYWwgdG8gdXNlIGBcXFxcPVsuLi5dJyB2ZXJ5IG1hbnkgdGltZXMsCiBiZWNhdXNl IGRpc3BsYXkgb2YgdGhlIGRvY3VtZW50YXRpb24gc3RyaW5nIHdvdWxkIGJlY29tZSBzbG93 LgpAQCAtMTYyNiw3ICsxNjI2LDcgQEAgY2hlY2tkb2MtdGhpcy1zdHJpbmctdmFsaWQtZW5n aW5lCiAJICAgICAoY2hlY2tkb2MtY3JlYXRlLWVycm9yCiAJICAgICAgKGNvbmNhdAogCSAg ICAgICAiS2V5Y29kZSAiIChtYXRjaC1zdHJpbmcgMSkKLQkgICAgICAgIiBlbWJlZGRlZCBp biBkb2Mgc3RyaW5nLiAgVXNlIFxcXFw8a2V5bWFwPiAmIFxcXFxbZnVuY3Rpb25dICIKKwkg ICAgICAgIiBlbWJlZGRlZCBpbiBkb2Mgc3RyaW5nLiAgVXNlIFxcXFw8bWFwdmFyPiAmIFxc XFxbY29tbWFuZF0gIgogCSAgICAgICAiaW5zdGVhZCIpCiAJICAgICAgKG1hdGNoLWJlZ2lu bmluZyAxKSAobWF0Y2gtZW5kIDEpIHQpKSkpCiAgICAgIDs7IE9wdGlvbmFsbHkgd2FybiBh Ym91dCB0b28gbWFueSBjb21tYW5kIHN1YnN0aXR1dGlvbnMuCkBAIC0xNjM2LDcgKzE2MzYs NyBAQCBjaGVja2RvYy10aGlzLXN0cmluZy12YWxpZC1lbmdpbmUKICAgICAgICAgICAgICAg ICAgICAgICAgICAgICAgICAgICAgICAoMSsgY2hlY2tkb2MtbWF4LWtleXJlZi1iZWZvcmUt d2FybikpCiAgICAgICAgICAgICAgICAgICAobm90IChyZS1zZWFyY2gtZm9yd2FyZCAiXFxc XFxcXFx7XFx3K30iIGUgdCkpKQogICAgICAgICAgICAgIChjaGVja2RvYy1jcmVhdGUtZXJy b3IKLSAgICAgICAgICAgICAgIlRvbyBtYW55IG9jY3VycmVuY2VzIG9mIFxcW2Z1bmN0aW9u XS4gIFVzZSBcXHtrZXltYXB9IGluc3RlYWQiCisgICAgICAgICAgICAgICJUb28gbWFueSBv Y2N1cnJlbmNlcyBvZiBcXFtjb21tYW5kXS4gIFVzZSBcXHttYXB2YXJ9IGluc3RlYWQiCiAg ICAgICAgICAgICAgIHMgKG1hcmtlci1wb3NpdGlvbiBlKSkpKSkKICAgICAgOzsgQW1iaWd1 b3VzIHF1b3RlZCBzeW1ib2wuICBXaGVuIGEgc3ltYm9sIGlzIGJvdGggYm91bmQgYW5kIGZi b3VuZCwKICAgICAgOzsgYW5kIGlzIHJlZmVycmVkIHRvIGluIGRvY3VtZW50YXRpb24sIGl0 IHNob3VsZCBiZSBwcmVmaXhlZCB3aXRoCi0tCjIuMzIuMC53aW5kb3dzLjEK --------------2096600613CF42C06FF4E384-- From debbugs-submit-bounces@debbugs.gnu.org Thu Sep 30 12:26:24 2021 Received: (at 50903-done) by debbugs.gnu.org; 30 Sep 2021 16:26:24 +0000 Received: from localhost ([127.0.0.1]:53792 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVyt1-0005Fr-N7 for submit@debbugs.gnu.org; Thu, 30 Sep 2021 12:26:24 -0400 Received: from eggs.gnu.org ([209.51.188.92]:45284) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mVysw-0005FV-NP for 50903-done@debbugs.gnu.org; Thu, 30 Sep 2021 12:26:18 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:52044) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mVysr-0005jm-I7; Thu, 30 Sep 2021 12:26:09 -0400 Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:2970 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mVysr-0003IW-5N; Thu, 30 Sep 2021 12:26:09 -0400 Date: Thu, 30 Sep 2021 19:26:18 +0300 Message-Id: <83tui2f2s5.fsf@gnu.org> From: Eli Zaretskii To: Nikolay Kudryavtsev In-Reply-To: <1f246932-4526-5afd-c699-a87714c7dc64@gmail.com> (message from Nikolay Kudryavtsev on Thu, 30 Sep 2021 16:35:59 +0300) Subject: Re: bug#50903: Checkdoc recommendation for docstring subsitutions is inconsistent with other documentation References: <70d5f8e1-0131-c0e2-1033-03911377e856@gmail.com> <83k0iyh2ut.fsf@gnu.org> <1f246932-4526-5afd-c699-a87714c7dc64@gmail.com> X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 50903-done Cc: 50903-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > From: Nikolay Kudryavtsev > Cc: 50903@debbugs.gnu.org > Date: Thu, 30 Sep 2021 16:35:59 +0300 > > Roger. s/r-d the patch. Thanks, installed. From unknown Fri Aug 15 03:57:20 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Fri, 29 Oct 2021 11:24:04 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator