unofficial mirror of guile-user@gnu.org 
 help / color / mirror / Atom feed
From: Maxime Devos <maximedevos@telenet.be>
To: Keith Wright <kwright@keithdiane.us>
Cc: guile-user@gnu.org
Subject: Re: [ANN] Scheme-GNUnet 0.2 released
Date: Thu, 03 Feb 2022 22:08:59 +0100	[thread overview]
Message-ID: <b5206a979da30ca4d06d47e1ec5e4ade13ddba88.camel@telenet.be> (raw)
In-Reply-To: <87h79fofbq.fsf@fcs22.keithdiane.us>

[-- Attachment #1: Type: text/plain, Size: 1150 bytes --]

Hi,

Keith Wright schreef op do 03-02-2022 om 15:39 [-0500]:
> Maxime Devos <maximedevos@telenet.be> writes:
> 
> > The source code can be found at <https://git.gnunet.org/gnunet-scheme.git/>,
> 
> > I can send a copy of the manual (PDF, HTML or TeXmacs) by mail if desired.
> 
> Would it not be easier to put the documentation in the same place
> as the source code?  (Possibly in a separate directory)

It is, in doc/scheme-gnunet.tm in the git repo!  And after running
"make", you can find the HTML in doc/scheme-gnunet.html and
doc/scheme-gnunet.pdf.

> As a proponent of literate programming (cf Knuth), I think the
> human readable documentation is part of the source code.
> An onle machine readable program, even if it is in some "high level"
> language, is really no better than a binary "blob", which
> could be de-compiled.

There's some comments and docstrings in the various .scm source files
explaining things.  It's not really ‘Knuth-level’ literate programming
though, were the ‘executable’ source code is extracted from the manual,
if that's what you were referring to here.

Greetings,
Maxime.

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 260 bytes --]

      reply	other threads:[~2022-02-03 21:08 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-03 18:11 [ANN] Scheme-GNUnet 0.2 released Maxime Devos
2022-02-03 20:39 ` Keith Wright
2022-02-03 21:08   ` Maxime Devos [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

  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=b5206a979da30ca4d06d47e1ec5e4ade13ddba88.camel@telenet.be \
    --to=maximedevos@telenet.be \
    --cc=guile-user@gnu.org \
    --cc=kwright@keithdiane.us \
    /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).