summaryrefslogtreecommitdiff
path: root/piem.el
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2020-09-19 12:47:37 -0400
committerKyle Meyer <kyle@kyleam.com>2020-09-19 12:47:37 -0400
commit7a98f40e99a1c06ef76e6c92694023c1d8309103 (patch)
treebeabc3eb1f68a5d4bb342ee9c659cbec8d0945df /piem.el
parent96d1dc07fd2854a11598a89eb7cf7b53bfc3b14c (diff)
downloadpiem-7a98f40e99a1c06ef76e6c92694023c1d8309103.tar.gz
Fill in missing library commentaries
These aren't too useful (and I don't want to duplicate what is or at least should be in the manual), but they're better than nothing.
Diffstat (limited to 'piem.el')
-rw-r--r--piem.el10
1 files changed, 10 insertions, 0 deletions
diff --git a/piem.el b/piem.el
index 9dce914..6ec757d 100644
--- a/piem.el
+++ b/piem.el
@@ -23,7 +23,17 @@
;;; Commentary:
+;; This library provides functionality for working with public-inbox
+;; archives [1] within Emacs (e.g., applying a patch series to the
+;; associated Git repository or downloading an mbox for the thread and
+;; injecting it into a local Maildir directory). The user option
+;; `piem-inboxes' defines a set of public-inbox archives. For most
+;; the functions here to do something useful, the current buffer needs
+;; to be linked to an inbox in that list, which requires enabling the
+;; minor mode provided by at least one integration library (such as
+;; `piem-gnus', `piem-eww', or `piem-notmuch').
;;
+;; [1] https://public-inbox.org/README
;;; Code: