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#60418: [PATCH] Add :vc keyword to use-package Date: Tue, 18 Apr 2023 15:13:44 +0300 Message-ID: <83ttxd8k1z.fsf@gnu.org> References: <87zgb6uk2r.fsf@hyperspace> <87tu0tl1s4.fsf@hyperspace> <87a5zt2emd.fsf@betli.tmit.bme.hu> <87fs9l9bim.fsf@posteo.net> <87y1n3zsro.fsf@posteo.net> <871qku220f.fsf@betli.tmit.bme.hu> <874jpq920b.fsf@posteo.net> <87cz4ezpwi.fsf@betli.tmit.bme.hu> <87h6tlinft.fsf@hyperspace> <87r0spa712.fsf@posteo.net> <87edopiif5.fsf@hyperspace> <87wn2bzvcp.fsf@hyperspace> <835y9vbyfr.fsf@gnu.org> <87mt36uwl8.fsf@hyperspace> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="28479"; mail-complaints-to="usenet@ciao.gmane.io" Cc: philipk@posteo.net, felician.nemeth@gmail.com, 60418@debbugs.gnu.org, stefankangas@gmail.com To: Tony Zorman Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Apr 18 14:14:19 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 1pokDy-0007C1-Jo for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 18 Apr 2023 14:14:18 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pokDj-0000oQ-L6; Tue, 18 Apr 2023 08:14:03 -0400 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 1pokDi-0000oF-OZ for bug-gnu-emacs@gnu.org; Tue, 18 Apr 2023 08:14:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pokDi-0000i7-GX for bug-gnu-emacs@gnu.org; Tue, 18 Apr 2023 08:14:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pokDh-0007T9-Pu for bug-gnu-emacs@gnu.org; Tue, 18 Apr 2023 08:14:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 18 Apr 2023 12:14:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 60418 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 60418-submit@debbugs.gnu.org id=B60418.168182002828679 (code B ref 60418); Tue, 18 Apr 2023 12:14:01 +0000 Original-Received: (at 60418) by debbugs.gnu.org; 18 Apr 2023 12:13:48 +0000 Original-Received: from localhost ([127.0.0.1]:58065 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pokDT-0007SV-Kk for submit@debbugs.gnu.org; Tue, 18 Apr 2023 08:13:47 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:39054) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pokDQ-0007SG-MN for 60418@debbugs.gnu.org; Tue, 18 Apr 2023 08:13:46 -0400 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 1pokDJ-0000dM-SV; Tue, 18 Apr 2023 08:13:37 -0400 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=7Is+GbQabiKWcQaqtgGmSJo8haPsOjCYcNNbZNArG3U=; b=Gk1CQPRuhv3P nSA7xQbW5Z4J//W3BZmrYj+QYAiJtRbjorzcQ61kJ1YhCYwgekmHReyml/zlSWoKJ63SLZVgphI/8 Yhq6xZ+0Hj6n2MoSMPzK9yxXSSh0YmCgcfx5vvCQAa1z0wvqRuXGGoEZRvsbz1X1xGRNoTAWsMMtU ifls4S4zOelE9jiFVW7rslSXyH8Byl6bU/6BHQLtoi1JUv0OCZBB4Brui/Y7eeiJNE3aVuEUOv9F+ QoEkOzkf21qoYnjAXGvjYy01c1rso73M1D8LSBgpKNqnfl5JQPkVPl01uSf4OuNzRq+sa9kPZtGtk MKjMXYE8hUh88gp13LIgvw==; Original-Received: from [87.69.77.57] (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 1pokDJ-0002zR-90; Tue, 18 Apr 2023 08:13:37 -0400 In-Reply-To: <87mt36uwl8.fsf@hyperspace> (message from Tony Zorman on Mon, 17 Apr 2023 21:39:47 +0200) 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:260222 Archived-At: > From: Tony Zorman > Cc: philipk@posteo.net, 60418@debbugs.gnu.org, felician.nemeth@gmail.com, > stefankangas@gmail.com > Date: Mon, 17 Apr 2023 21:39:47 +0200 > > >> +(defun use-package-handler/:vc (name _keyword arg rest state) > >> + "Generate code for the :vc keyword." > > > > I don't think this is an accurate description of what the function > > does. Also, we try very hard to mention at least the mandatory > > arguments in the first line of the doc strings. > > I think I initially copied this from the handler for ":custom" (where > it's perhaps more applicable) and then forgot to change it. Still, I'm > not totally sure what to write here without assuming that the reader > already knows what the handler for a use-package keyword does (which is, > I guess, why none of the other handlers have much in the way of > documentation). Would it be a good idea to link to a relevant entry in > the info manual ((use-package) > Keyword extensions > Creating an > extension)? You could say something short on the first line assuming the reader knows, then explain a bit more in the subsequent lines. And yes, pointing to the Info manual is also an option, but something should still be in the doc string.