From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.devel Subject: Re: Silence checkdoc for symbols designating major and minor modes Date: Wed, 28 Jul 2021 14:46:57 +0000 Message-ID: <87fsvyfqce.fsf@posteo.net> References: <87k0lbfmto.fsf@posteo.net> <83tukeu0zl.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="29753"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Wed Jul 28 16:47:44 2021 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 1m8kqW-0007V0-5B for ged-emacs-devel@m.gmane-mx.org; Wed, 28 Jul 2021 16:47:44 +0200 Original-Received: from localhost ([::1]:45178 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m8kqV-0008Ix-3z for ged-emacs-devel@m.gmane-mx.org; Wed, 28 Jul 2021 10:47:43 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36392) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m8kpr-0007NN-5b for emacs-devel@gnu.org; Wed, 28 Jul 2021 10:47:03 -0400 Original-Received: from mout01.posteo.de ([185.67.36.65]:45127) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m8kpp-0004Ze-0Y for emacs-devel@gnu.org; Wed, 28 Jul 2021 10:47:02 -0400 Original-Received: from submission (posteo.de [89.146.220.130]) by mout01.posteo.de (Postfix) with ESMTPS id A4EF7240029 for ; Wed, 28 Jul 2021 16:46:58 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1627483618; bh=hlddXDqh9qnvZ6ufwWczxIyh4RQdSf7AcV4DKwwyj54=; h=From:To:Cc:Subject:Autocrypt:Date:From; b=QsoHuu7A9lKTsxamkYYQ2G04e5wAlCIyuogz9UNUWNtUjotm/EeOCU+TztIssORSL 7CyE0myypAWNRAKJ6Ls8IjGl4y+UuBweHL2awYVcLl0M4J1mGG8mw9RHNu8sCB5oqd 8J3c1Yfvnv4x7TyHrhmHUmdrFrx0QxN+G95zdGdRGt554ZDFkgUt2JfcZZDcvVo5NP 48mlHTM52IMhtm5TfEKCsMnfDJpR9bLVPMK29S1BY/PhfBzYpIhco4QSxnnuyHx0K2 3hdihDn/EvczBQnBGY1AdY4x1eCKg89xgAZZnAqz/ivYhhFf9CJ/+64KrKQKfzR6YK eDkJj82eQQL9A== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4GZc1s6yhMz6tmJ; Wed, 28 Jul 2021 16:46:57 +0200 (CEST) Autocrypt: addr=philipk@posteo.net; prefer-encrypt=mutual; keydata= mDMEYHHqUhYJKwYBBAHaRw8BAQdAp3GdmYJ6tm5McweY6dEvIYIiry+Oz9rU4MH6NHWK0Ee0QlBo aWxpcCBLYWx1ZGVyY2ljIChnZW5lcmF0ZWQgYnkgYXV0b2NyeXB0LmVsKSA8cGhpbGlwa0Bwb3N0 ZW8ubmV0PoiQBBMWCAA4FiEEDM2H44ZoPt9Ms0eHtVrAHPRh1FwFAmBx6lICGwMFCwkIBwIGFQoJ CAsCBBYCAwECHgECF4AACgkQtVrAHPRh1FyTkgEAjlbGPxFchvMbxzAES3r8QLuZgCxeAXunM9gh io0ePtUBALVhh9G6wIoZhl0gUCbQpoN/UJHI08Gm1qDob5zDxnIHuDgEYHHqUhIKKwYBBAGXVQEF AQEHQNcRB+MUimTMqoxxMMUERpOR+Q4b1KgncDZkhrO2ql1tAwEIB4h4BBgWCAAgFiEEDM2H44Zo Pt9Ms0eHtVrAHPRh1FwFAmBx6lICGwwACgkQtVrAHPRh1Fw1JwD/Qo7kvtib8jy7puyWrSv0MeTS g8qIxgoRWJE/KKdkCLEA/jb9b9/g8nnX+UcwHf/4VfKsjExlnND3FrBviXUW6NcB In-Reply-To: <83tukeu0zl.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 28 Jul 2021 14:33:18 +0300") Received-SPF: pass client-ip=185.67.36.65; envelope-from=philipk@posteo.net; helo=mout01.posteo.de X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 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, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 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:271748 Archived-At: Eli Zaretskii writes: >> From: Philip Kaludercic >> Date: Tue, 27 Jul 2021 21:50:43 +0000 >> >> an issue I have been having when documenting code is that checkdoc wants >> me to disambiguate symbols referring to major or minor modes. That >> usually means adding "function", "command" "variable", "option" or >> "symbol" but in my experience these usually do not fit. In fact, most of >> the time it is obvious what is meant when referring to a major/minor >> mode. First of all, I have to correct myself: This only applies to minor modes, because they are both bound and fbound. >> >> ... Foo when `bar-mode' is active ... >> >> The patch I added below silences the disambiguation request when a >> symbol ends in "-mode". Alternatively, one could also add a "minor mode" >> and "major mode" to the list of accepted keywords, but I think that >> would sound to repetitive: >> >> ... Foo when minor mode `bar-mode' is active ... >> >> Opinions? > > First, the code, if installed, should have a comment explaining why > these strings are being exempted. Of course, this was just a first suggestion. > More generally, could you please show an example of a doc string and > the warning(s) it triggers? I'm not sure I understand the problem > well enough to make up my mind. (Do all of our existing modes suffer > from this problem?) I noticed this when updating the rcirc docstrings. For example, I still have the issue here: (defcustom rcirc-omit-responses '("JOIN" "PART" "QUIT" "NICK") "Responses which will be hidden when `rcirc-omit-mode' is enabled." :type '(repeat string)) triggering this response: Disambiguate rcirc-omit-mode by preceding w/ function,command,variable,option or symbol. Browsing through the repository, I also discovered the same issue in turn-on-eldoc-mode's docstring. There are other examples in third-party code I remember, but couldn't find right now. > Thanks. -- Philip Kaludercic