summaryrefslogtreecommitdiff
path: root/tissue/web
diff options
context:
space:
mode:
authorArun Isaac2022-10-07 17:41:11 +0530
committerArun Isaac2022-10-07 18:40:31 +0530
commitebdd54ec7a786657968bfdb0d083e87100bb8a3e (patch)
tree219e5798d0ea4839c5d8abda5ed231e47e8d45a8 /tissue/web
parentad1d15f79c1bffda4a4a2e333b38a3f1eb8d1ef9 (diff)
downloadtissue-ebdd54ec7a786657968bfdb0d083e87100bb8a3e.tar.gz
tissue-ebdd54ec7a786657968bfdb0d083e87100bb8a3e.tar.lz
tissue-ebdd54ec7a786657968bfdb0d083e87100bb8a3e.zip
tissue: Markup docstrings in texinfo syntax.
* tissue/document.scm (slot-set): Markup docstring in texinfo syntax. * tissue/file-document.scm (read-gemtext-document): Markup docstring in texinfo syntax. * tissue/git.scm (git-tracked-files): Markup docstring in texinfo syntax. * tissue/issue.scm (read-gemtext-issue): Markup docstring in texinfo syntax. * tissue/tissue.scm (gemtext-files-in-directory): Markup docstring in texinfo syntax. * tissue/web/static.scm (exporter, copier, gemtext-exporter, skribe-exporter): Markup docstrings in texinfo syntax.
Diffstat (limited to 'tissue/web')
-rw-r--r--tissue/web/static.scm14
1 files changed, 8 insertions, 6 deletions
diff --git a/tissue/web/static.scm b/tissue/web/static.scm
index 69a9d90..fc3a211 100644
--- a/tissue/web/static.scm
+++ b/tissue/web/static.scm
@@ -61,15 +61,15 @@ NEW-EXTENSION."
new-extension))
(define (exporter file proc)
- "Return a writer function that exports FILE using PROC. PROC is
-passed two arguments---the input port to read from and the output port
-to write to."
+ "Return a writer function that exports @var{file} using
+@var{proc}. @var{proc} is passed two arguments---the input port to
+read from and the output port to write to."
(lambda (out)
(call-with-file-in-git (current-git-repository) file
(cut proc <> out))))
(define (copier file)
- "Return a writer function that copies FILE."
+ "Return a writer function that copies @var{file}."
(exporter file
(lambda (in out)
(port-transduce (tmap (cut put-bytevector out <>))
@@ -84,7 +84,8 @@ to write to."
#:join-lines? #t))
(define* (gemtext-exporter file #:optional (reader (gemtext-reader)))
- "Return a writer function that exports FILE, a gemtext file."
+ "Return a writer function that reads gemtext @var{file} using
+@var{reader} and exports it."
(exporter file
(lambda (in out)
(with-output-to-port out
@@ -93,7 +94,8 @@ to write to."
(find-engine 'html))))))
(define* (skribe-exporter file #:optional (reader (make-reader 'skribe)))
- "Return a writer function that exports FILE, a skribe file."
+ "Return a writer function that reads skribe @var{file} using
+@var{reader} and exports it."
(exporter file
(lambda (in out)
(with-output-to-port out