From: Adam <adam.niederer@gmail.com>
To: Karl Fogel <kfogel@red-bean.com>, "T.V Raman" <raman@google.com>
Cc: emacs-devel@gnu.org
Subject: Re: [NonGNU ELPA] New packages: elquery, file-ring, metamorph
Date: Tue, 29 Mar 2022 01:23:14 -0400 [thread overview]
Message-ID: <55171e46-5bf3-e924-9717-3990ea0206e9@gmail.com> (raw)
In-Reply-To: <87h77hctk0.fsf@red-bean.com>
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.
next prev parent reply other threads:[~2022-03-29 5:23 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-28 3:58 [NonGNU ELPA] New packages: elquery, file-ring, metamorph Adam
2022-03-28 6:59 ` Visuwesh
2022-03-28 17:21 ` T.V Raman
2022-03-29 1:53 ` T.V Raman
2022-03-29 3:43 ` Karl Fogel
2022-03-29 5:23 ` Adam [this message]
2022-03-29 13:51 ` T.V Raman
2022-03-31 1:55 ` Adam
2022-03-31 12:48 ` Stefan Monnier
2022-04-01 3:28 ` Adam
2022-04-01 13:11 ` Stefan Monnier
2022-04-03 10:25 ` Stephen Leake
2022-03-29 13:50 ` T.V Raman
2022-03-29 14:42 ` Stephen Leake
2022-03-29 8:28 ` Stefan Monnier
2022-03-28 22:09 ` Adam
2022-03-28 23:10 ` Ergus
2022-04-01 9:10 ` Augusto Stoffel
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=55171e46-5bf3-e924-9717-3990ea0206e9@gmail.com \
--to=adam.niederer@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=kfogel@red-bean.com \
--cc=raman@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).