unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
From: ludo@gnu.org (Ludovic Courtès)
To: guile-devel@gnu.org
Subject: Re: Custom printers for SRFI-9 records
Date: Thu, 27 May 2010 00:34:15 +0200	[thread overview]
Message-ID: <87d3wimgwo.fsf@gnu.org> (raw)
In-Reply-To: AANLkTikW--WRMvpnRIz3BxD1v06rAD1lUSQC7wpz6Kcz@mail.gmail.com

Hi,

No Itisnt <theseaisinhere@gmail.com> writes:

> On Tue, May 25, 2010 at 3:56 PM, No Itisnt <theseaisinhere@gmail.com> wrote:
>> I agree. Here's a patch that adds (srfi srfi-9 gnu) with
>> set-record-printer! and adds a subsection to the SRFI-9 part of the
>> manual for it.
>> I can go ahead and commit it, if that's OK.

This looks good to me.

> diff --git a/doc/ref/srfi-modules.texi b/doc/ref/srfi-modules.texi
> index 0d192fa..b3f9946 100644
> --- a/doc/ref/srfi-modules.texi
> +++ b/doc/ref/srfi-modules.texi
> @@ -1922,6 +1922,35 @@ The functions created by @code{define-record-type} are ordinary
>  top-level @code{define}s.  They can be redefined or @code{set!} as
>  desired, exported from a module, etc.
>  
> +@menu
> +* SRFI-9 Custom printers::      Customizing print behavior.
> +@end menu
> +
> +@node SRFI-9 Custom printers
> +@subsubsection Custom printers

Use @unnumberedsubsubsec instead and no menu.  Capitalize like this:
“SRFI-9 Custom Printers”.

> +You may use @code{set-record-printer!} to customize the default printing
> +behavior of records. This is a GUILE extension and is not part of SRFI-9. It is

s/GUILE/Guile/ and two spaces after and end-of-sentence period.

> +located in the @nicode{(srfi srfi-9 gnu)} module.
> +
> +@deffn {library syntax} set-record-printer! name thunk

Rather use @deffn{Scheme Syntax}, which seems to be the most commonly
used form in the manual.

> +This example prints the employee's name in brackets, for instance ``@code{[Fred]}''.

No need for ``quotes'' here.

> +(define (set-record-printer! type thunk)
> +  (struct-set! type vtable-index-printer thunk))

I’d rather call it ‘set-record-type-printer!’ (it prints records, but
it’s the printer of the record type).  What do you think?

You could add a docstring here.

And don’t forget to add srfi-9/gnu.scm to ‘SRFI_SOURCES’ in
modules/Makefile.am.

Thanks,
Ludo’.




  parent reply	other threads:[~2010-05-26 22:34 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-05-25  0:26 Custom printers for SRFI-9 records No Itisnt
2010-05-25 19:23 ` Ludovic Courtès
     [not found]   ` <AANLkTilzb959cEaRDcpFUntPK_r0q_9RsIE5pByG4QPm@mail.gmail.com>
2010-05-26  4:18     ` No Itisnt
2010-05-26 21:09       ` No Itisnt
2010-05-26 22:04         ` Ludovic Courtès
2010-05-26 22:42         ` Ludovic Courtès
2010-05-26 22:34       ` Ludovic Courtès [this message]
2010-05-27  2:41         ` No Itisnt
2010-05-27  8:20           ` Ludovic Courtès

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=87d3wimgwo.fsf@gnu.org \
    --to=ludo@gnu.org \
    --cc=guile-devel@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.
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).