From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Adam Newsgroups: gmane.emacs.devel Subject: Re: [NonGNU ELPA] New packages: elquery, file-ring, metamorph Date: Tue, 29 Mar 2022 01:23:14 -0400 Message-ID: <55171e46-5bf3-e924-9717-3990ea0206e9@gmail.com> References: <878rsuh8ai.fsf@gmail.com> <87h77hctk0.fsf@red-bean.com> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="22287"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.7.0 Cc: emacs-devel@gnu.org To: Karl Fogel , "T.V Raman" Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Mar 29 07:23:58 2022 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 1nZ4Kj-0005b7-Ik for ged-emacs-devel@m.gmane-mx.org; Tue, 29 Mar 2022 07:23:57 +0200 Original-Received: from localhost ([::1]:34524 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nZ4Ki-0005nt-94 for ged-emacs-devel@m.gmane-mx.org; Tue, 29 Mar 2022 01:23:56 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:40008) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nZ4K6-00056f-ND for emacs-devel@gnu.org; Tue, 29 Mar 2022 01:23:21 -0400 Original-Received: from [2607:f8b0:4864:20::833] (port=36451 helo=mail-qt1-x833.google.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nZ4K5-0003ZI-4o for emacs-devel@gnu.org; Tue, 29 Mar 2022 01:23:18 -0400 Original-Received: by mail-qt1-x833.google.com with SMTP id s11so14385583qtc.3 for ; Mon, 28 Mar 2022 22:23:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:date:mime-version:user-agent:content-language:to:cc :references:from:subject:in-reply-to:content-transfer-encoding; bh=HU8sH7atsFISWbLlTbvZ5xGdDUwcc3AESAQwK2K1Edg=; b=UplDxmXIS1mgq1jM55YbC+zifIsQ8bBdZD2/yix3Qc43kMuo3e/jn6yX1hyEBy/AmP Tq9+N4UtNn3nY9stlPx+S+CFBpePNxLy6/bbssBFpp0/3VEboXzsARlulT7OoE6yx6gY Yl7D7eZ1w4bV0Ew8mwlAjpQgBEyO4dB3JAxSbclpsvVi+2DoRr3nGiWqiP63wv8XUPsU cEyLgrw3wTczpEJ3rnXgNccA74I2xtb7l3MlClwwVsQh7f6CxYffuOjKStT9Eig1wLMx zEVE4NbbU7W9usEoVmlf7Q84D0I8gjOXoq/vb6BJzCf299e6+HaHedGRwZZ20Q8hpVqP /h9Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:date:mime-version:user-agent :content-language:to:cc:references:from:subject:in-reply-to :content-transfer-encoding; bh=HU8sH7atsFISWbLlTbvZ5xGdDUwcc3AESAQwK2K1Edg=; b=5WN5/mGNHbPyA5HNhhdHbxapI0zyxWIobEVV8E+WKdLGiW/mrPE0ZWI/ka1GB1UvkW UI9l2ZfD05BA5+T6rvGLmUIQ+9IYOpqt66VdhjmQlKppqHQg0cdDM/96e1KT+fBzqqis NG/ACUzDxUVngTtfow7uZ4EeV/+9hpDCbKzltahNepgIFwzCkCh5bZL3yDYuLWfHCQRr qrjZ2JMRRT+zYHL/4zdt3cGlFXBszJcF9/vEY6sRNx1/FQxHBxK0BNIEcrQvkG6xGI/S xqnZctqxs/Ll0KwNQtpprE0yCTwpZEoGMhNHdjKCUsrv+JQFbq9DKme8JNvmRYUhjg2y jBJg== X-Gm-Message-State: AOAM533Pqm923yg/PMMSAMT4UM0F4w+kNg3jiPmgIv985Tsx14cHFzF5 1DeVsaTkcKPSzqH1cRauIuQ= X-Google-Smtp-Source: ABdhPJzn4foHIM57H1i7XkxN37hpyJAkKGtXsFD5+Fir2DBIECJtPGMHzdAy4If2WYDjkqkrZ4D/ww== X-Received: by 2002:a05:622a:1213:b0:2e0:5fe8:542a with SMTP id y19-20020a05622a121300b002e05fe8542amr25822204qtx.347.1648531395894; Mon, 28 Mar 2022 22:23:15 -0700 (PDT) Original-Received: from [10.36.0.7] ([89.187.179.55]) by smtp.gmail.com with ESMTPSA id f34-20020a05622a1a2200b002e1a35ed1desm14868060qtb.94.2022.03.28.22.23.15 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 28 Mar 2022 22:23:15 -0700 (PDT) Content-Language: en-US In-Reply-To: <87h77hctk0.fsf@red-bean.com> X-Host-Lookup-Failed: Reverse DNS lookup failed for 2607:f8b0:4864:20::833 (failed) Received-SPF: pass client-ip=2607:f8b0:4864:20::833; envelope-from=adam.niederer@gmail.com; helo=mail-qt1-x833.google.com X-Spam_score_int: -6 X-Spam_score: -0.7 X-Spam_bar: / X-Spam_report: (-0.7 / 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, FREEMAIL_FROM=0.001, NICE_REPLY_A=-0.001, PDS_HP_HELO_NORDNS=0.659, RCVD_IN_DNSWL_NONE=-0.0001, RDNS_NONE=0.793, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 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:287548 Archived-At: On 3/28/22 23:43, Karl Fogel wrote: > On 28 Mar 2022, T.V Raman wrote: >> Sadly putting the examples in README is not very helpful since >> installing your package from melpa doesn't appear to bring down the >> README; one shouldn't need to click through to Github to find out how to >> use it if one has installed the package. > > Hunh.  Would that be something we should make a general fix for? E.g., > when a package 'foo' gets installed from melpa or from some similar > package repository, and it has a README, then the README gets installed > alongside the package as 'foo-README', or something like that? I think that's a good way of going about it. From a cursory glance it looks like the most popular out-of-tree libraries (s, f, a, ht, epl, async, ov, popup, uuidgen) have most of their usage examples and documentation in the README. Even if NonGNU's supposed to be a bit more curated, having everybody synchronize their README with docstrings or texi manuals might be a bit wasteful. I don't know if there's a way to do that automatically.