unofficial mirror of guile-user@gnu.org 
 help / color / mirror / Atom feed
From: Daniel Tornabene <d.t.peters777@gmail.com>
To: Olivier Dion <olivier.dion@polymtl.ca>
Cc: guix-user@gnu.org, guile-user <guile-user@gnu.org>, guix-days@gnu.org
Subject: Re: Proposal: Deep Dive into the Guile Docs & Makeover Proposal
Date: Tue, 8 Feb 2022 11:25:05 -0600	[thread overview]
Message-ID: <CAMo=-SBK4dz=SmWzOSgY81rQeY5hnRC+r5JgK9QpfcMa=gs1dg@mail.gmail.com> (raw)
In-Reply-To: <87mtj15rax.fsf@laura>

Very much agree with "How to setup a project" example, I should consider
offering my own example at some point after Blake has worked through his
approach.  Really onboard with this comment overall, the fact that C
interop is included directly in the manual is important, and something I've
been meaning to write about myself from a different direction for some time
now, and I wasn't even aware of the catch/throw change, a perfect thing to
highlight or restructure.

On Tue, Feb 8, 2022 at 10:13 AM Olivier Dion via General Guile related
discussions <guile-user@gnu.org> wrote:

> On Tue, 08 Feb 2022, Blake Shaw <blake@nonconstructivism.com> wrote:
> > * SUMMARY: Recent discussions on the Guix mailing list revealed that
> > many in the Guix community have found the Guile Reference Manual
> > difficult to navigate as newcomers. That should come as no surprise --
> > in PDF form, the docs span approximately /850 pages/, making it a
> > quite hefty set of documents for an implementation of a minimal
> > programming language like Scheme, even when compared to the
> > documentation of relatively large PLs; the Racket Guide, for instannce,
> > is only 450 pages, while the Rust Book is approximately 550 pages.
>
> Don't forget that Guile as a lot of legacy stuff in its manual.  For
> example `catch/throw` -- the old way of doing exception, althought it's
> not clear what new projects should use -- is documented there.  There's
> also the details of its implementation, indices, appendices, functions
> in C, many SRFI and modules.  So it's true that scheme is a very simple
> language, but Guile is not only Scheme.
>
> I think there's certainly things that could be trim away to save some
> space, maybe some restructuration, but I think that overall the manual
> is great when you get use to it.
>
> In my opinion, the thing that lack in the manual is a complete "How to
> setup a project" example that is a more complex project than the tortoise
> tutorial.  Having this section with condensed informations would be
> easier for newbies than sparsed informations across hundreds of pages.
> I had to learn that the hardway by reading multiple times the manual, and
> looking at Guix and Guile source code.
>
> --
> Olivier Dion
> Polymtl
>
>


  reply	other threads:[~2022-02-08 17:25 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-08  7:36 Proposal: Deep Dive into the Guile Docs & Makeover Proposal Blake Shaw
2022-02-08  9:07 ` Neil Jerram
2022-02-08 11:46   ` Blake Shaw
2022-02-08 15:22     ` Daniel Tornabene
2022-02-08 10:16 ` Jérémy Korwin-Zmijowski
2022-02-08 14:45 ` james
2022-02-08 15:08 ` Olivier Dion via General Guile related discussions
2022-02-08 17:25   ` Daniel Tornabene [this message]
2022-02-10 17:20 ` Christine Lemmer-Webber
  -- strict thread matches above, loose matches on Subject: below --
2022-02-08 13:06 Blake Shaw
2022-02-08 15:21 Blake Shaw
2022-02-08 16:59 Blake Shaw
2022-02-08 17:28 ` Daniel Tornabene
2022-02-16 22:06 Blake Shaw
2022-02-17 16:58 Blake Shaw
2022-02-18 17:48 ` Olivier Dion via General Guile related discussions
2022-02-19 12:17 ` Neil Jerram
2022-02-19 15:33   ` Olivier Dion via General Guile related discussions
2022-02-19 17:35     ` adriano
2022-02-18 18:05 Blake Shaw

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/guile/

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

  git send-email \
    --in-reply-to='CAMo=-SBK4dz=SmWzOSgY81rQeY5hnRC+r5JgK9QpfcMa=gs1dg@mail.gmail.com' \
    --to=d.t.peters777@gmail.com \
    --cc=guile-user@gnu.org \
    --cc=guix-days@gnu.org \
    --cc=guix-user@gnu.org \
    --cc=olivier.dion@polymtl.ca \
    /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.
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).