From 3a02125ad752209e349a94ff7a470a2d79aff699 Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Wed, 7 Aug 2019 22:58:11 +0530
Subject: doc: Document mbox->emails.

* doc/guile-email.texi (Reading Email): New chapter.
* email/email.scm (mbox->emails): Add docstring.
---
 email/email.scm | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'email/email.scm')

diff --git a/email/email.scm b/email/email.scm
index fdba01f..2c4178e 100644
--- a/email/email.scm
+++ b/email/email.scm
@@ -901,4 +901,6 @@ list of header keys and values."
     email))
 
 (define (mbox->emails port)
+  "Read next email from PORT and return as a bytevector.  PORT is an
+input port reading an mbox file."
   (read-objects read-next-email-in-mbox port))
-- 
cgit v1.2.3