From 7a98f40e99a1c06ef76e6c92694023c1d8309103 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Sat, 19 Sep 2020 12:47:37 -0400 Subject: 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. --- piem-b4.el | 4 ++++ piem-elfeed.el | 4 +++- piem-eww.el | 4 +++- piem-gnus.el | 4 +++- piem-notmuch.el | 5 ++++- piem.el | 10 ++++++++++ 6 files changed, 27 insertions(+), 4 deletions(-) diff --git a/piem-b4.el b/piem-b4.el index 596e563..75b2344 100644 --- a/piem-b4.el +++ b/piem-b4.el @@ -21,7 +21,11 @@ ;;; Commentary: +;; This library provides a Transient [1] interface to b4 [2]. It is +;; documented in the piem manual. ;; +;; [1] https://magit.vc/manual/transient/ +;; [2] https://git.kernel.org/pub/scm/utils/b4/b4.git ;;; Code: diff --git a/piem-elfeed.el b/piem-elfeed.el index add7547..c0cc5a3 100644 --- a/piem-elfeed.el +++ b/piem-elfeed.el @@ -21,7 +21,9 @@ ;;; Commentary: -;; +;; This library provides a minor mode, `piem-elfeed-mode', that +;; modifies `piem' variables to teach functions like `piem-inbox' how +;; to extract information from Elfeed buffers. ;;; Code: diff --git a/piem-eww.el b/piem-eww.el index 849a3b5..69b6000 100644 --- a/piem-eww.el +++ b/piem-eww.el @@ -21,7 +21,9 @@ ;;; Commentary: -;; +;; This library provides a minor mode, `piem-eww-mode', that modifies +;; `piem' variables to teach functions like `piem-inbox' how to +;; extract information from EWW buffers. ;;; Code: diff --git a/piem-gnus.el b/piem-gnus.el index 172468f..4afa747 100644 --- a/piem-gnus.el +++ b/piem-gnus.el @@ -21,7 +21,9 @@ ;;; Commentary: -;; +;; This library provides a minor mode, `piem-gnus-mode', that modifies +;; `piem' variables to teach functions like `piem-inbox' and +;; `piem-am-ready-mbox' how to extract information from Gnus buffers. ;;; Code: diff --git a/piem-notmuch.el b/piem-notmuch.el index 7941736..cd3153a 100644 --- a/piem-notmuch.el +++ b/piem-notmuch.el @@ -21,7 +21,10 @@ ;;; Commentary: -;; +;; This library provides a minor mode, `piem-notmuch-mode', that +;; modifies `piem' variables to teach functions like `piem-inbox' and +;; `piem-am-ready-mbox' how to extract information from Notmuch +;; buffers. ;;; Code: 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: -- cgit v1.2.3