all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Ludovic Courtès" <ludo@gnu.org>
To: Jan Nieuwenhuizen <janneke@gnu.org>
Cc: Guix-devel <guix-devel@gnu.org>
Subject: Re: extending the documentation of the Scheme API
Date: Mon, 30 Dec 2019 19:38:33 +0100	[thread overview]
Message-ID: <87fth17j6e.fsf@gnu.org> (raw)
In-Reply-To: <87v9pzv8ye.fsf@gnu.org> (Jan Nieuwenhuizen's message of "Sun, 29 Dec 2019 09:20:57 +0100")

Hi!

Jan Nieuwenhuizen <janneke@gnu.org> skribis:

>> 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?
>
> If you are talking about guix records and (guix build utils); I think it
> would be great if these were split off from Guix.  I guess that
> documenting them right now, as a first step, would be nice in itself.

It’s quite clear that the future of (guix build utils), or parts of it,
will be Gash-Core-Utils somehow.

I’m not sure about records: they’re not completely set in stone and it’s
handy to have them in the same repo, but eventually, it’ll be nicer to
have them “elsewhere.”  Same for monads.

(I like the “monorepo” approach though.  Perhaps we could have one big
Guile library repo?  :-))

In the meantime, I think documenting (guix build utils) would be helpful
to packagers.  Documenting ‘define-record-type*’ would be nice as well.

Thanks,
Ludo’.

      reply	other threads:[~2019-12-30 18:38 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
2019-12-23 11:44 ` Bengt Richter
2019-12-29  8:20 ` Jan Nieuwenhuizen
2019-12-30 18:38   ` Ludovic Courtès [this message]

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87fth17j6e.fsf@gnu.org \
    --to=ludo@gnu.org \
    --cc=guix-devel@gnu.org \
    --cc=janneke@gnu.org \
    /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 external index

	https://git.savannah.gnu.org/cgit/guix.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.