From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: [elpa] externals/vertico-posframe 39dbdfe 6/7: Fix checkdoc warn. Date: Fri, 29 Oct 2021 16:57:29 +0300 Message-ID: <83h7d0q6gm.fsf@gnu.org> References: <20211029015739.26727.26392@vcs0.savannah.gnu.org> <20211029015754.E319220983@vcs0.savannah.gnu.org> <831r44s5s4.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="17935"; mail-complaints-to="usenet@ciao.gmane.io" Cc: tumashu@163.com, emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Oct 29 15:59:17 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 1mgSPd-0004Rk-9L for ged-emacs-devel@m.gmane-mx.org; Fri, 29 Oct 2021 15:59:17 +0200 Original-Received: from localhost ([::1]:49232 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mgSPc-0006kY-CQ for ged-emacs-devel@m.gmane-mx.org; Fri, 29 Oct 2021 09:59:16 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36966) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mgSOC-0005cs-B2 for emacs-devel@gnu.org; Fri, 29 Oct 2021 09:57:48 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:36116) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mgSO9-0002E9-Nv; Fri, 29 Oct 2021 09:57:45 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From: Date; bh=lpA1/LQ/zLejNpAd2A5Bw/2pe7Jmp5iKF5DXVWI+yJs=; b=P4h936+7z1QmTBpac2gv MW02sOffuzLRYfVh0tavy4iM3/vxj+sd6BQ0cTnbm2+VIqi0samimHFwcM36Pt4d7wIN27kZ4mgc5 CoPRMootPV3YtB5SM7uPRxA6TIpPW5a+lv4ZU98VGRhHE4Oxq1Hl/iNGBoI4UJ0yCCH53s+LEHwd4 9ja4yY95eRuVeMVyzh9c2nyBGgmQO0ZaZAx0J5zwxzMZcJZHeapPibAeCxo6Itl7/LuP+Ri0Kj01P 8zfWZc6toy7yyi04bBwVqxwx/38CLZJcQmQKP03qqSqRt4LYcOAKoZOePuJiIsvG1AxG9wqpAWUsP 1XDwWmi5wI93Zg==; Original-Received: from [87.69.77.57] (port=4531 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 1mgSO9-00017X-72; Fri, 29 Oct 2021 09:57:45 -0400 In-Reply-To: (message from Stefan Monnier on Fri, 29 Oct 2021 09:42:14 -0400) 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:278194 Archived-At: > From: Stefan Monnier > Cc: emacs-devel@gnu.org, tumashu@163.com > Date: Fri, 29 Oct 2021 09:42:14 -0400 > > > Many times people don't reference the arguments there because they are > > unaware of our style conventions, or because they cannot find the > > wording which would mention the arguments and still stay within the > > 80-char limitation. > > Hmm... AFAIK this warning is unrelated to the first line or the 80 > columns conventions. It just says things like: > > Argument ‘prompt’ should appear (as PROMPT) in the doc string People sometimes give up mentioning the arguments because they cannot find good words to describe them. This pressure is higher for the first line.