From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: Silence checkdoc for symbols designating major and minor modes Date: Fri, 30 Jul 2021 17:47:16 -0400 Message-ID: References: <87k0lbfmto.fsf@posteo.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="13268"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: emacs-devel@gnu.org To: Philip Kaludercic Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Jul 30 23:48:59 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 1m9aNH-0003FU-1m for ged-emacs-devel@m.gmane-mx.org; Fri, 30 Jul 2021 23:48:59 +0200 Original-Received: from localhost ([::1]:38984 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m9aNF-00079v-8S for ged-emacs-devel@m.gmane-mx.org; Fri, 30 Jul 2021 17:48:57 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:35410) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m9aLj-0006Nq-K5 for emacs-devel@gnu.org; Fri, 30 Jul 2021 17:47:23 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:6083) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m9aLg-0001Ak-Sd for emacs-devel@gnu.org; Fri, 30 Jul 2021 17:47:22 -0400 Original-Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id 0B1E7441240; Fri, 30 Jul 2021 17:47:19 -0400 (EDT) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id D267E44122D; Fri, 30 Jul 2021 17:47:17 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1627681637; bh=RxMYabJxVnRu7ZBPlUhSoU/HJs6ucFKwWEoS+SsIbG8=; h=From:To:Cc:Subject:References:Date:In-Reply-To:From; b=mmvHyyt/FQFxJ3HM7xjI9M2/DWl4T68d7pPwxLbh2jjmf4tocXcY/KuOyFyb0ui49 feFo+i4sxKXNIKdrth2Y/dktG/9hSTNS3nJ36tMlMF2b/F6aAmFvVbCm3VY1Dc/J4Z fxk6r8UA/K9ygC0zmdQGL/Jxb3wfHDN6IO83LT6pjfNLq0cI6VvlXd0PDcsIuQCsal 3hbhxhTNne5fATIp5R11vh0uhW01XqEpI5FldW/LZkmxLkvyI6IxgoI+zUOxFwmT45 AZ677k4bYyWGUxFYuKZv8a+MdxYMrhIKj4jG6yhoVGLHk8yg/22/nQZ/WFzKYd12u0 v1ve+EzCJFkdg== Original-Received: from alfajor (unknown [216.154.29.138]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 845B5120533; Fri, 30 Jul 2021 17:47:17 -0400 (EDT) In-Reply-To: <87k0lbfmto.fsf@posteo.net> (Philip Kaludercic's message of "Tue, 27 Jul 2021 21:50:43 +0000") Received-SPF: pass client-ip=132.204.25.50; envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3, 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:271876 Archived-At: Philip Kaludercic [2021-07-27 21:50:43] wrote: > 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. I think it's a problem in checkdoc, which wants to impose a style which is not usually followed in Emacs (and which `describe-symbol` makes even less important). Stefan