From mboxrd@z Thu Jan 1 00:00:00 1970 From: =?utf-8?Q?Ludovic_Court=C3=A8s?= Subject: Re: extending the documentation of the Scheme API Date: Mon, 30 Dec 2019 19:38:33 +0100 Message-ID: <87fth17j6e.fsf@gnu.org> References: <87sgleprp6.fsf@elephly.net> <87v9pzv8ye.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([2001:470:142:3::10]:55379) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ilzw5-00079W-Ou for guix-devel@gnu.org; Mon, 30 Dec 2019 13:38:38 -0500 In-Reply-To: <87v9pzv8ye.fsf@gnu.org> (Jan Nieuwenhuizen's message of "Sun, 29 Dec 2019 09:20:57 +0100") List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: "Guix-devel" To: Jan Nieuwenhuizen Cc: Guix-devel Hi! Jan Nieuwenhuizen skribis: >> we have lots of nice macros and procedures in Guix that aren=E2=80=99t >> 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=E2=80=99s quite clear that the future of (guix build utils), or parts of= it, will be Gash-Core-Utils somehow. I=E2=80=99m not sure about records: they=E2=80=99re not completely set in s= tone and it=E2=80=99s handy to have them in the same repo, but eventually, it=E2=80=99ll be nicer= to have them =E2=80=9Celsewhere.=E2=80=9D Same for monads. (I like the =E2=80=9Cmonorepo=E2=80=9D approach though. Perhaps we could h= ave one big Guile library repo? :-)) In the meantime, I think documenting (guix build utils) would be helpful to packagers. Documenting =E2=80=98define-record-type*=E2=80=99 would be n= ice as well. Thanks, Ludo=E2=80=99.