From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: "T.V Raman" Newsgroups: gmane.emacs.devel Subject: Re: [NonGNU ELPA] New packages: elquery, file-ring, metamorph Date: Tue, 29 Mar 2022 06:51:17 -0700 Message-ID: <25155.3797.364679.875916@retriever.mtv.corp.google.com> References: <878rsuh8ai.fsf@gmail.com> <87h77hctk0.fsf@red-bean.com> <55171e46-5bf3-e924-9717-3990ea0206e9@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="2373"; mail-complaints-to="usenet@ciao.gmane.io" Cc: kfogel@red-bean.com, raman@google.com, emacs-devel@gnu.org To: adam.niederer@gmail.com Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Mar 29 15:53:19 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 1nZCHd-0000PV-Az for ged-emacs-devel@m.gmane-mx.org; Tue, 29 Mar 2022 15:53:17 +0200 Original-Received: from localhost ([::1]:52816 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nZCHb-0001wO-UL for ged-emacs-devel@m.gmane-mx.org; Tue, 29 Mar 2022 09:53:15 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:59746) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nZCFp-0000Sx-EC for emacs-devel@gnu.org; Tue, 29 Mar 2022 09:51:25 -0400 Original-Received: from [2607:f8b0:4864:20::102b] (port=55131 helo=mail-pj1-x102b.google.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nZCFn-0008BI-8p for emacs-devel@gnu.org; Tue, 29 Mar 2022 09:51:24 -0400 Original-Received: by mail-pj1-x102b.google.com with SMTP id y16so4729522pju.4 for ; Tue, 29 Mar 2022 06:51:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; h=from:mime-version:content-transfer-encoding:message-id:date:to:cc :subject:in-reply-to:references; bh=uD8t0EWUSpzkQ43KEG6yyjthCtWpO2jWED74XhtfMIY=; b=Ekh9qqF0z0gizwSw7KksNUDDLWqflptT6Ai/Sn4p+DDdKvYgBI+97VqDwO1oljyT4q 6kmT9ujhGDx3OqYCVXw0XTuCK/k1NX7gtTq6BabkvK+CPhU/GnJJs3frcRRibAfmSlwf 21UQl3XfYaxnNKC/RwY5qbTnkZFWRoYlnP+8hJLhbES2wtY7spKAytHqHxOEoy63FAES kalgHH8S3Iuyf+4LMbKQME3sO5JYZGomoE8LMtx98N6byyF6OMwOB3RikklwZHLH5L6Y gtkoA5YbND6+3QV4/tllXdS6y6phavTSCL8FeLjhf6HrbP8L7aBwIWlsKNlYj0uAUZzq YFcA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:mime-version:content-transfer-encoding :message-id:date:to:cc:subject:in-reply-to:references; bh=uD8t0EWUSpzkQ43KEG6yyjthCtWpO2jWED74XhtfMIY=; b=tjWuLhEn5rr3itWVg2+RlMJ8QukX/TgL50lHMbzGeZi6RFmRqbQdl+FRtssSLsff1N ah1CXenL1+xUAI9yNCURdj53h6Z+2ce6eeWQroWv43/Z8QmMenEC79cvOxmJYse5gd/i XjHhBHqeQ7weitQlKZm8A0TelmBBODePsMWTScjpgjSIMS/SXkcW+KAkSuc0tJyuqIz9 Kp1vfXTOV9cC8xO1CNDfQTAlOis5zNQ6XPxhmYj+swlmq/1W3KGYlkU6ucwtHMKEZ6Me b5MBGRyduoRm/VCYYSZFJBBeJfO+4jAtDlQu+lsl5seIibuMEKoleaRJALhZdxDfxvLV AO4Q== X-Gm-Message-State: AOAM533xPSjmdcYACArHoFLhjpiDqkHHB9hMDW5YqQiWknlVCWof2iIE nqK4jOHoKL0/S3JRYyUpF0H7Lf6DICdJMA== X-Google-Smtp-Source: ABdhPJyKfVo7yPlGk2wumk3ccPHWgnd0rKsUdBj5KNLGgslJfjhavtTlVNOTxBBRMIfLRRM0DolsGQ== X-Received: by 2002:a17:90b:3851:b0:1c7:80f9:5306 with SMTP id nl17-20020a17090b385100b001c780f95306mr4576084pjb.207.1648561878643; Tue, 29 Mar 2022 06:51:18 -0700 (PDT) Original-Received: from retriever.mtv.corp.google.com ([2620:0:1000:1510:852e:3e9c:26f6:eee0]) by smtp.gmail.com with ESMTPSA id 135-20020a62198d000000b004fa9a8f73casm20098276pfz.99.2022.03.29.06.51.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 29 Mar 2022 06:51:18 -0700 (PDT) In-Reply-To: <55171e46-5bf3-e924-9717-3990ea0206e9@gmail.com> X-Mailer: VM 8.1.1 under 29.0.50 (x86_64-pc-linux-gnu) X-Host-Lookup-Failed: Reverse DNS lookup failed for 2607:f8b0:4864:20::102b (failed) Received-SPF: pass client-ip=2607:f8b0:4864:20::102b; envelope-from=raman@google.com; helo=mail-pj1-x102b.google.com X-Spam_score_int: -161 X-Spam_score: -16.2 X-Spam_bar: ---------------- X-Spam_report: (-16.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_MED=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, ENV_AND_HDR_SPF_MATCH=-0.5, 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, USER_IN_DEF_DKIM_WL=-7.5, USER_IN_DEF_SPF_WL=-7.5 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:287557 Archived-At: 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 t= he > >> README; one shouldn't need to click through to Github to find out= how to > >> use it if one has installed the package. > >=20 > > Hunh.=C2=A0 Would that be something we should make a general fix f= or=3F E.g.,=20 > > when a package 'foo' gets installed from melpa or from some simila= r=20 > > package repository, and it has a README, then the README gets inst= alled=20 > > alongside the package as 'foo-README', or something like that=3F >=20 > I think that's a good way of going about it. From a cursory glance i= t=20 > looks like the most popular out-of-tree libraries (s, f, a, ht, epl,= =20 > async, ov, popup, uuidgen) have most of their usage examples and=20 > documentation in the README. >=20 > Even if NonGNU's supposed to be a bit more curated, having everybody= =20 > synchronize their README with docstrings or texi manuals might be a = bit=20 > wasteful. I don't know if there's a way to do that automatically. --=20 Thanks, --Raman(I Search, I Find, I Misplace, I Research) =E2=99=89 Id: kg:/m/0285kf1 =F0=9F=A6=AE -- Thanks, --Raman(I Search, I Find, I Misplace, I Research) ♉ Id: kg:/m/0285kf1 🦮