From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?utf-8?B?Sm/Do28gVMOhdm9yYQ==?= Newsgroups: gmane.emacs.devel Subject: docstring has wrong usage of unescaped single quotes (use \= or different quoting) Date: Fri, 22 Jul 2022 11:24:01 +0100 Message-ID: <87fsitphry.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="18559"; mail-complaints-to="usenet@ciao.gmane.io" To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Jul 22 12:24:16 2022 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1oEppP-0004iC-UD for ged-emacs-devel@m.gmane-mx.org; Fri, 22 Jul 2022 12:24:15 +0200 Original-Received: from localhost ([::1]:38006 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oEppN-0004ik-Gh for ged-emacs-devel@m.gmane-mx.org; Fri, 22 Jul 2022 06:24:13 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:58854) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oEpo6-00041A-Rl for emacs-devel@gnu.org; Fri, 22 Jul 2022 06:22:54 -0400 Original-Received: from mail-wm1-x32f.google.com ([2a00:1450:4864:20::32f]:44650) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oEpo1-0000vx-TE for emacs-devel@gnu.org; Fri, 22 Jul 2022 06:22:54 -0400 Original-Received: by mail-wm1-x32f.google.com with SMTP id b21-20020a05600c4e1500b003a32bc8612fso2226207wmq.3 for ; Fri, 22 Jul 2022 03:22:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:subject:date:message-id:mime-version :content-transfer-encoding; bh=hcNTCaS6zbWObRx11xHhvNuM9G2DfbB9aMDDK1xBAFA=; b=cRd1oDWM+TyNvV+MRoZN3DvywOtyGPnMkBkPHX2eokgopuc6PuYB3PS2aPv+ABAfRC MWwusGcaWGFBnTa9sZODjYtEzrRYe32RDI9xV8zIxxiQHEV7lqoH2lAJ5C6CfklYSciR fJLrcm6leL/lExGGYkzfZrkw4vJ0uhklnBNRQf7DV1tr4+0TzYgtFO+f1/KWgniVZh3D BhfbbLQ6cerKOvTINTooHdXKQPoTBwC0coxMlUn+CAgLMf8VQbLO9XwtlQ81pHePJIQ4 eahGrBJdz//i19JbzKER5+FjlNFq6H7CBBbLutDNS6IhB2Lv2koZjrzwKEUVE7iNPbVH 3q/g== 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:date:message-id:mime-version :content-transfer-encoding; bh=hcNTCaS6zbWObRx11xHhvNuM9G2DfbB9aMDDK1xBAFA=; b=Rwsrtu8sz5hTELzi/PJXL5fwwV+p+evIOE4NRJjNrg2W+oCafT4DdeQmEOB9Kdp5si 3oyL67l78FQ/XddE85xm71ULu4oPh1AL0oMns42lqzBrAGjj8AACm787xkKaP26yBT1o dcjxcVdvIrcZG2L57KevelDf4W6ieb/bcFLFj2xD1PCUTrnH5DD6m1nYZmp1Uk6M+m6T ortFYsGyTIO6U5WYN4zylcsS16LjTi/pWw2fgLLsc78I8XTXZ4ma/8w6hXf8Tumbqbf+ A8TqVoTfckmpICrA87sp0eUR2DtXiXDPqLPNqk6d3rLq95CaQDl5BpcWjyC1+Z3pCCHe 5E0w== X-Gm-Message-State: AJIora8vFo1636jdNhuL8kErwqbzfnSdphqA0jZ/2lKE+GIhFBN2hhyR pBhGAuEg9caUqNBxKAQZtqNS2LtRC3E= X-Google-Smtp-Source: AGRyM1tUSjRCBcSQ9p/P5O0fPpCEIrebnR2QPxBNYn3nPUAvcdNkzUtqmx/nWxi9ENjIq6NmdZYcJw== X-Received: by 2002:a05:600c:511f:b0:3a3:254c:b079 with SMTP id o31-20020a05600c511f00b003a3254cb079mr2159113wms.68.1658485367058; Fri, 22 Jul 2022 03:22:47 -0700 (PDT) Original-Received: from krug (87-196-72-209.net.novis.pt. [87.196.72.209]) by smtp.gmail.com with ESMTPSA id i24-20020a1c5418000000b003a3187a2d4csm8320708wmb.22.2022.07.22.03.22.46 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 22 Jul 2022 03:22:46 -0700 (PDT) Received-SPF: pass client-ip=2a00:1450:4864:20::32f; envelope-from=joaotavora@gmail.com; helo=mail-wm1-x32f.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_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, T_SPF_HELO_TEMPERROR=0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:292413 Archived-At: Hi, This byte-compilation warning pops up all over the place now. I've fixed it in some of my packages, but when byte-compiling I'm interested in those warnings that, when unheeded, could cause my program logic to produce incorrect results and/or waste resources. Perhaps I'm mistaken, but this does not seem like one such thing. This is particularly noisy when hunting problems with 'flymake-mode'. Docstring checking code should go into "checkdoc", so one has a choice of removing its checkdoc backend and the associated noise if one is not interested in it. Furthermore, in a tangent issue, I don't understand exactly the suggestion in the warning message. How exactly is \=3D to be used? \=3D' doesn't work. In one of my docstrings I had an elisp snippet for users to copy-paste and I ended replacing the quote character with the 'quote' special form, which works but now produces an inferior docstring. Thanks, Jo=C3=A3o