From mboxrd@z Thu Jan  1 00:00:00 1970
From: Jesse Gibbons <jgibbons2357@gmail.com>
Subject: Re: extending the documentation of the Scheme API
Date: Fri, 20 Dec 2019 21:04:16 -0700
Message-ID: <77d56dafca86b5b86f3a64c92e65a2588af2207c.camel@gmail.com>
References: <87sgleprp6.fsf@elephly.net>
Mime-Version: 1.0
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 8bit
Return-path: <guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([2001:470:142:3::10]:44100)
 by lists.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <jgibbons2357@gmail.com>) id 1iiW05-0002lv-K1
 for guix-devel@gnu.org; Fri, 20 Dec 2019 23:04:22 -0500
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <jgibbons2357@gmail.com>) id 1iiW04-0006i8-HU
 for guix-devel@gnu.org; Fri, 20 Dec 2019 23:04:21 -0500
Received: from mail-pj1-x102f.google.com ([2607:f8b0:4864:20::102f]:36156)
 by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16)
 (Exim 4.71) (envelope-from <jgibbons2357@gmail.com>)
 id 1iiW04-0006cW-71
 for guix-devel@gnu.org; Fri, 20 Dec 2019 23:04:20 -0500
Received: by mail-pj1-x102f.google.com with SMTP id n59so5005689pjb.1
 for <guix-devel@gnu.org>; Fri, 20 Dec 2019 20:04:19 -0800 (PST)
In-Reply-To: <87sgleprp6.fsf@elephly.net>
List-Id: "Development of GNU Guix and the GNU System distribution."
 <guix-devel.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/guix-devel>,
 <mailto:guix-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/guix-devel>
List-Post: <mailto:guix-devel@gnu.org>
List-Help: <mailto:guix-devel-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/guix-devel>,
 <mailto:guix-devel-request@gnu.org?subject=subscribe>
Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org
Sender: "Guix-devel" <guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org>
To: Ricardo Wurmus <rekado@elephly.net>, Guix-devel <guix-devel@gnu.org>

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.