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.
---
 doc/guile-email.texi | 9 +++++++++
 email/email.scm      | 2 ++
 2 files changed, 11 insertions(+)

diff --git a/doc/guile-email.texi b/doc/guile-email.texi
index aa462cb..ed43d5a 100644
--- a/doc/guile-email.texi
+++ b/doc/guile-email.texi
@@ -24,6 +24,7 @@ Documentation License''.
 * Data Types:: Data types provided by guile-email
 * Encoding and Decoding:: Encoding and decoding Base64, Quoted-Printable
   and Q-encoding
+* Reading Email:: Reading emails from the mbox format
 * Contributing:: Contributing
 
 Indices
@@ -444,6 +445,14 @@ Decode Q-encoding encoded string @var{str} and return the decoded
 bytevector.
 @end deffn
 
+@node Reading Email
+@chapter Reading Email
+
+@deffn {Scheme Procedure} mbox->emails port
+Read next email from @var{port} and return as a bytevector.  @var{port}
+is an input port reading an mbox file.
+@end deffn
+
 @node Contributing
 @chapter Contributing
 
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