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/WwwAtomStream.pm | 3 +++
 1 file changed, 3 insertions(+)

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

diff --git a/lib/PublicInbox/WwwAtomStream.pm b/lib/PublicInbox/WwwAtomStream.pm
index 38eba2a0..712c3dc8 100644
--- a/lib/PublicInbox/WwwAtomStream.pm
+++ b/lib/PublicInbox/WwwAtomStream.pm
@@ -2,6 +2,9 @@
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 #
 # Atom body stream for which yields getline+close methods
+# 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::WwwAtomStream;
 use strict;
 use warnings;
-- 
cgit v1.2.3-24-ge0c7