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.bugs Subject: bug#67217: [PATCH] Improve docstring argument conventions Date: Fri, 17 Nov 2023 09:06:16 +0200 Message-ID: <83a5rcq2on.fsf@gnu.org> References: <874jhmvapa.fsf@jeremybryant.net> <83y1eyp6l4.fsf@gnu.org> <87v8a1tfoo.fsf@jeremybryant.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="31364"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 67217-done@debbugs.gnu.org To: Jeremy Bryant Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Nov 17 08:07:21 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1r3swj-00080C-BL for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 17 Nov 2023 08:07:21 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r3swT-00074K-GV; Fri, 17 Nov 2023 02:07:05 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r3swQ-000741-Cf for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2023 02:07:02 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1r3swQ-0003PV-3G for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2023 02:07:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1r3swP-0000zo-U4 for bug-gnu-emacs@gnu.org; Fri, 17 Nov 2023 02:07:01 -0500 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Fri, 17 Nov 2023 07:07:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 67217 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Mail-Followup-To: 67217@debbugs.gnu.org, eliz@gnu.org, jb@jeremybryant.net Original-Received: via spool by 67217-done@debbugs.gnu.org id=D67217.17002047923771 (code D ref 67217); Fri, 17 Nov 2023 07:07:01 +0000 Original-Received: (at 67217-done) by debbugs.gnu.org; 17 Nov 2023 07:06:32 +0000 Original-Received: from localhost ([127.0.0.1]:45000 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r3svw-0000yl-Fb for submit@debbugs.gnu.org; Fri, 17 Nov 2023 02:06:32 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:44656) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r3svu-0000yT-2R for 67217-done@debbugs.gnu.org; Fri, 17 Nov 2023 02:06:31 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r3svo-0003Ji-FN; Fri, 17 Nov 2023 02:06:24 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=WlZAqtuqQiOmreoSVqOVnOzt44AOoY8J9DGkBVEZFhs=; b=epJYzybcxr8F CmwPd0DIDwYRO5SyrvkUgyv4jYSUMWlNGurupJ1ZWdpKTjpqYv25q3Cp7ZLM74jzKzBKhZzn2xDsD oypsv9CiGQuw2wJirW7OMpXWmd3xM4r14+E9NEZZZ9EeadiP+6dG0w2+jpAaVKpuJHur7e/SVPrLp zhxVekISHDxlAnqJS2QCh4TDl1iPbYWQnnFR88m7n8Pcv9VICqK2onQj7IrXPD6YFi4EBqRata+lX th6BE8x6+h3veVOoPFXe0T5uLau8yzz5psRowtfF/2trzgMovKJMiXjGpQH3mzL56vtm5jOm6JZgm GPnrxxeMId1M58qbnTGvsg==; In-Reply-To: <87v8a1tfoo.fsf@jeremybryant.net> (message from Jeremy Bryant on Thu, 16 Nov 2023 23:55:29 +0000) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:274488 Archived-At: > From: Jeremy Bryant > Cc: 67217@debbugs.gnu.org > Date: Thu, 16 Nov 2023 23:55:29 +0000 > > > Eli Zaretskii writes: > > > So let me turn the table and ask you: why did you think the existing > > text is insufficient in this aspect? > > I thought your wording was clearer than the manual and proposed adapting > the manual to your wording and to be more explicit about mandatory and optional. > > I accept that it is comparable. "Mandatory" is just my personal rule of thumb, which is just easy to explain. But maybe you are right, and it helps explain this tip, thanks for pointing that out. So I've now added a note about mandatory arguments there, in the hope that it helps. And with that, I'm closing the bug.