summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRicardo Wurmus <rekado@elephly.net>2017-11-10 23:15:16 +0100
committerRicardo Wurmus <rekado@elephly.net>2017-11-10 23:15:16 +0100
commitfbe7d79ca552e74d34254641803a6ce0c4b00cae (patch)
treea4065045f7dfbb8f4a14f8cbac08b916389ffa37
parent50b64124497b33c64e530bb5750e1b4057bfdf51 (diff)
debbugs: Add doc strings.
* debbugs/operations.scm (newest-bugs, get-status, get-bug-log): Add doc strings.
-rw-r--r--debbugs/operations.scm5
1 files changed, 5 insertions, 0 deletions
diff --git a/debbugs/operations.scm b/debbugs/operations.scm
index e1ed93d..3eb0812 100644
--- a/debbugs/operations.scm
+++ b/debbugs/operations.scm
@@ -23,6 +23,8 @@
#:use-module (srfi srfi-1))
(define-public (newest-bugs amount)
+ "Return a list of bug numbers corresponding to the newest AMOUNT
+bugs."
(soap-request
`(ns1:newest_bugs
(@ (xmlns:ns1 . "urn:Debbugs/SOAP")
@@ -32,6 +34,8 @@
(map string->number ((sxpath '(// urn:Debbugs/SOAP:item *text*)) response-body)))))
(define-public (get-status bug-ids)
+ "Return <bug> records containing the details for the bugs identified
+by BUG-IDS, a list of bug numbers."
(soap-request
`(ns1:get_status
(@ (xmlns:ns1 . "urn:Debbugs/SOAP")
@@ -49,6 +53,7 @@
(map soap-bug->bug bugs)))))
(define-public (get-bug-log bug-id)
+ "Return emails associated with the bug identified by BUG-ID."
(soap-request
`(ns1:get_bug_log
(@ (xmlns:ns1 . "urn:Debbugs/SOAP")