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

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

diff --git a/lib/PublicInbox/ContentId.pm b/lib/PublicInbox/ContentId.pm
index dd3155be..9baf0e76 100644
--- a/lib/PublicInbox/ContentId.pm
+++ b/lib/PublicInbox/ContentId.pm
@@ -1,6 +1,11 @@
 # Copyright (C) 2018 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
+# Unstable internal API.
+# Used for on-the-fly duplicate detection in V2 inboxes.
+# This is not stored in any database anywhere and may change
+# as changes in duplicate detection are needed.
+# See L<public-inbox-v2-format(5)> manpage for more details.
 package PublicInbox::ContentId;
 use strict;
 use warnings;
-- 
cgit v1.2.3-24-ge0c7