aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2025-03-28 02:23:33 +0000
committerArun Isaac2025-03-28 02:26:04 +0000
commit3bf4cb75dca135e52efd216bb06d34541b2dc092 (patch)
treee647a88857829cd67eb4de77d7bc210031348ace
parent32a69b4312621f5119377b25d3e6ab8fa5e804e8 (diff)
downloadguix-forge-3bf4cb75dca135e52efd216bb06d34541b2dc092.tar.gz
guix-forge-3bf4cb75dca135e52efd216bb06d34541b2dc092.tar.lz
guix-forge-3bf4cb75dca135e52efd216bb06d34541b2dc092.zip
doc: Add record-field-ref.
* doc/skribilo.scm (record-field-ref): New public function.
-rw-r--r--doc/skribilo.scm7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/skribilo.scm b/doc/skribilo.scm
index bd2c313..be40014 100644
--- a/doc/skribilo.scm
+++ b/doc/skribilo.scm
@@ -45,6 +45,7 @@
record-documentation
record-field
record-ref
+ record-field-ref
docstring-function-documentation))
;; Constants
@@ -301,6 +302,12 @@ are a list of <record-field> objects."
(ref #:ident identifier
#:text (code identifier)))
+(define (record-field-ref record-identifier field-identifier)
+ "Link to documentation of field identified by @var{field-identifier} in
+record identified by @var{record-identifier}."
+ (ref #:ident (string-append record-identifier "-" field-identifier)
+ #:text (code field-identifier)))
+
(define-record-type <function>
(function name arguments docstring)
function?