From: Pjotr Prins <pjotr.public12@thebird.nl>
To: Jesse Gibbons <jgibbons2357@gmail.com>
Cc: Guix-devel <guix-devel@gnu.org>
Subject: Re: extending the documentation of the Scheme API
Date: Sat, 21 Dec 2019 06:24:42 -0600 [thread overview]
Message-ID: <20191221122442.w7o5ffuciex4fydz@thebird.nl> (raw)
In-Reply-To: <77d56dafca86b5b86f3a64c92e65a2588af2207c.camel@gmail.com>
On Fri, Dec 20, 2019 at 09:04:16PM -0700, Jesse Gibbons wrote:
> On Fri, 2019-12-20 at 23:17 +0100, Ricardo Wurmus wrote:
> > Hi Guix,
> >
> > we have lots of nice macros and procedures in Guix that aren’t
> > documented beyond their docstrings.
> >
> > Should we snarf the docstrings and add them to the manual?
> >
> > --
> > Ricardo
> >
> >
> I don't care where it goes, but is there maybe a better place than the guix
> manual?
>
> Am I alone in thinking it makes sense to produce a "guix api reference
> manual"? The guix manual is already fairly large. We can treat the guix
> manual as a manual for setting up guix and using it from a shell, the guix
> api reference manual as a reference for `guix repl` and more complex package
> and service production.
>
> This is just something I think we should consider.
How about a Guix hackers manual? Bliss from the REPL. I think that is
one of the key assets of Guix while it is still pretty hard to get at
without documentation.
Pj.
next prev parent reply other threads:[~2019-12-21 12:31 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-20 22:17 extending the documentation of the Scheme API Ricardo Wurmus
2019-12-21 1:45 ` John Soo
2019-12-21 4:04 ` Jesse Gibbons
2019-12-21 12:24 ` Pjotr Prins [this message]
2019-12-23 11:44 ` Bengt Richter
2019-12-29 8:20 ` Jan Nieuwenhuizen
2019-12-30 18:38 ` Ludovic Courtès
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://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191221122442.w7o5ffuciex4fydz@thebird.nl \
--to=pjotr.public12@thebird.nl \
--cc=guix-devel@gnu.org \
--cc=jgibbons2357@gmail.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/guix.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).