summaryrefslogtreecommitdiff
path: root/doc/skribilo.scm
diff options
context:
space:
mode:
authorArun Isaac2023-08-09 16:33:58 +0100
committerArun Isaac2023-08-09 16:43:59 +0100
commited00ffbaa86a8ef1c25fccd16e96315ca5d2505e (patch)
tree725531259f2c76b3ab98ca7530df58cd68abb459 /doc/skribilo.scm
parenta0225f0b5492578372896d63b6ce7bd9ab041b31 (diff)
downloadguix-forge-ed00ffbaa86a8ef1c25fccd16e96315ca5d2505e.tar.gz
guix-forge-ed00ffbaa86a8ef1c25fccd16e96315ca5d2505e.tar.lz
guix-forge-ed00ffbaa86a8ef1c25fccd16e96315ca5d2505e.zip
doc: Add record-ref convenience function.
* doc/skribilo.scm (record-ref): New public function. * doc/forge.skb: Use record-ref.
Diffstat (limited to 'doc/skribilo.scm')
-rw-r--r--doc/skribilo.scm7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/skribilo.scm b/doc/skribilo.scm
index 4058e62..c3b8efc 100644
--- a/doc/skribilo.scm
+++ b/doc/skribilo.scm
@@ -44,6 +44,7 @@
source-ref
record-documentation
record-field
+ record-ref
docstring-function-documentation))
;; Constants
@@ -294,6 +295,12 @@ are a list of <record-field> objects."
(record-field-documentation documented-field))))
fields)))))
+(define (record-ref identifier)
+ "Link to record documentation of record identified by
+@var{identifier}."
+ (ref #:ident identifier
+ #:text (code identifier)))
+
(define-record-type <function>
(function name arguments docstring)
function?