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: Wed, 30 Mar 2022 21:55:22 -0400 Message-ID: <6490b69b-36b6-67e9-a124-b5086935dd04@gmail.com> References: <878rsuh8ai.fsf@gmail.com> <87h77hctk0.fsf@red-bean.com> <55171e46-5bf3-e924-9717-3990ea0206e9@gmail.com> <25155.3797.364679.875916@retriever.mtv.corp.google.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="24288"; 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: kfogel@red-bean.com, emacs-devel@gnu.org To: "T.V Raman" Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Thu Mar 31 03:56: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 1nZk3W-00068r-Ip for ged-emacs-devel@m.gmane-mx.org; Thu, 31 Mar 2022 03:56:58 +0200 Original-Received: from localhost ([::1]:51000 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nZk3U-000147-Py for ged-emacs-devel@m.gmane-mx.org; Wed, 30 Mar 2022 21:56:56 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:52594) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nZk24-0000IB-8m for emacs-devel@gnu.org; Wed, 30 Mar 2022 21:55:29 -0400 Original-Received: from [2607:f8b0:4864:20::f2c] (port=41614 helo=mail-qv1-xf2c.google.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nZk22-0003z3-NG for emacs-devel@gnu.org; Wed, 30 Mar 2022 21:55:27 -0400 Original-Received: by mail-qv1-xf2c.google.com with SMTP id gh15so18700382qvb.8 for ; Wed, 30 Mar 2022 18:55:23 -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=xkdII5lwLWlX/C2fmz2GmT95aJ++Nm545CG+pMlV8Ro=; b=Tfnl+hBmjXoCzOUfuEW1rUxfau+vY27jw9v/nDoXP3PQEPHNpLzWv+JPV6RpHE1//y aQfQBnQbVZyIJWslQLBdQ0JGtV456maCaF3c1blkLlBdBk0IpGX7hM/Pr1y/+H1HWL8O Y+tuH4HKwbZNHl+iql3AeZXJhnCIe9M+BE0ejVmsVcdHwwa8X7iluLGxvlzPPzH7DVkp f7M/1AYgRlNxCK+cDUGtd0WGwKaRjRz2aT9cWL6asboeBTfs+mXQSZ8w18GG8axuGvnq WmdU4+0iHVroXU1OkxGf7rgZdB35aLT5HVPOFMJGH00DOsYOUu8Jn9AcZp/o0sn1INC/ GkMA== 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=xkdII5lwLWlX/C2fmz2GmT95aJ++Nm545CG+pMlV8Ro=; b=ZGMBYLnLwMlb/RkKl3wBCBtP0qTpY+bFroXAIQUKbWbrsvDSqXSbIPjw9MPGthN/1V JmP0mxC9vhm/XoRoRjjgq7ldjD4yFFZivA/cPqeG9ZjsGB5nzAGGYmVNHk+ROhK3HVJV 0TTfKbDb4O4em7LT8hkCqVVsJYCwiWaKoK3PiKOb0dwmKb8lrJ7gfDxIvs6nadrBuMeB CDetQDliFgzLgID5wszKvGWkric+0AXAKSXO58rsaLRtNT2YvXSUbHvbJRhKscCOULVm 8hb1m2rMLiBzl5CWKDp3DKzCJWHk5VU0gVJZtWwKYfnX97hg/KipFlB3nYutw0Lrgic6 9mIA== X-Gm-Message-State: AOAM530g3RmeONewG5eNfBu4s0gGVktqHqzFSEiMDdxcIfGL8aDpqNIZ QA5kpTPBDxvwNgG6lLV/SmY= X-Google-Smtp-Source: ABdhPJwwq5G2PfHqancGCvez8cj7vEL8T2wHQkVDd+tjYJ9n4fDf9oHGYn5siaYW0Fe5lnhJcKbpiw== X-Received: by 2002:a05:6214:242a:b0:441:1e13:5dcd with SMTP id gy10-20020a056214242a00b004411e135dcdmr2077485qvb.121.1648691723406; Wed, 30 Mar 2022 18:55:23 -0700 (PDT) Original-Received: from [192.168.1.215] (pool-96-245-184-196.phlapa.fios.verizon.net. [96.245.184.196]) by smtp.gmail.com with ESMTPSA id bs32-20020a05620a472000b0067d4560a516sm12147610qkb.32.2022.03.30.18.55.22 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Wed, 30 Mar 2022 18:55:23 -0700 (PDT) Content-Language: en-US In-Reply-To: <25155.3797.364679.875916@retriever.mtv.corp.google.com> X-Host-Lookup-Failed: Reverse DNS lookup failed for 2607:f8b0:4864:20::f2c (failed) Received-SPF: pass client-ip=2607:f8b0:4864:20::f2c; envelope-from=adam.niederer@gmail.com; helo=mail-qv1-xf2c.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:287620 Archived-At: I've devised a way to create an info file from my README with a bit of clever formatting and pandoc, which should solve the issue of documentation not being shipped to the user. Perhaps the build process could convert the README to an info file if no texi files exist in the repository? -Adam On 3/29/22 09:51, T.V Raman wrote: > > The better solution would be for the package to come with a short info > file -- see packages like embark. Then the info file just shows up > when you hit info. > Adam writes: > > 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. >