[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
02/04: doc: Recommend 'match-record'.
From: |
guix-commits |
Subject: |
02/04: doc: Recommend 'match-record'. |
Date: |
Thu, 8 Dec 2022 08:20:39 -0500 (EST) |
civodul pushed a commit to branch version-1.4.0
in repository guix.
commit 883aa80b45c10628322c52f9912188d3a85b5639
Author: Ludovic Courtès <ludo@gnu.org>
AuthorDate: Sat Nov 19 22:40:35 2022 +0100
doc: Recommend 'match-record'.
* doc/contributing.texi (Data Types and Pattern Matching): Recommend
'match-record'.
---
doc/contributing.texi | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/doc/contributing.texi b/doc/contributing.texi
index 40ae33ecac..6a8ffd6524 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -1089,11 +1089,16 @@ and then to browse them ``by hand'' using @code{car},
@code{cdr},
notably the fact that it is hard to read, error-prone, and a hindrance
to proper type error reports.
+@findex define-record-type*
+@findex match-record
+@cindex pattern matching
Guix code should define appropriate data types (for instance, using
@code{define-record-type*}) rather than abuse lists. In addition, it
should use pattern matching, via Guile’s @code{(ice-9 match)} module,
especially when matching lists (@pxref{Pattern Matching,,, guile, GNU
-Guile Reference Manual}).
+Guile Reference Manual}); pattern matching for records is better done
+using @code{match-record} from @code{(guix records)}, which, unlike
+@code{match}, verifies field names at macro-expansion time.
@node Formatting Code
@subsection Formatting Code