From a9cab9c477b74b3b828c26aa64e70d88c9d6744c Mon Sep 17 00:00:00 2001
From: Eric Wong <e@80x24.org>
Date: Mon, 7 Jan 2019 09:09:51 +0000
Subject: doc: various overview-level module comments

Hopefully this helps people familiarize themselves with
the source code.
---
 lib/PublicInbox/Mbox.pm | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

(limited to 'lib/PublicInbox/Mbox.pm')

diff --git a/lib/PublicInbox/Mbox.pm b/lib/PublicInbox/Mbox.pm
index 11b23022..78dbe27e 100644
--- a/lib/PublicInbox/Mbox.pm
+++ b/lib/PublicInbox/Mbox.pm
@@ -1,8 +1,12 @@
 # Copyright (C) 2015-2018 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
-# Streaming interface for formatting messages as an mboxrd.
-# Used by the web interface
+# Streaming (via getline) interface for formatting messages as an mboxrd.
+# Used by the PSGI web interface.
+#
+# public-inbox-httpd favors "getline" response bodies to take a
+# "pull"-based approach to feeding slow clients (as opposed to a
+# more common "push" model)
 package PublicInbox::Mbox;
 use strict;
 use warnings;
-- 
cgit v1.2.3-24-ge0c7