From 25e5049f59ef9af895156c12191f997cdec5b5a3 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Tue, 24 Feb 2026 14:56:55 -0500 Subject: [PATCH] doc/README.rst: minor wording update --- doc/README.rst | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/doc/README.rst b/doc/README.rst index 4a119b7..49554d2 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -35,18 +35,13 @@ and Roundcube, but they are all optional. How it works ============ -Each plugin knows how to do perform actions: +Each plugin knows how to perform three actions: prune, rename, and +remove. Mailshears figures out which plugins need to be run, and then +runs them in succession. -* prune -* rename -* remove - -Depending on how you invoke mailshears, it figures out which plugins -need to be run, and then runs them in succession. - -By default, mailshears won't actually do anything. There's a variable -``i_mean_business: false`` in the config file that must be set to -``true`` before mailshears will modify the system. +By default, mailshears won't actually do anything. There's an +``i_mean_business: false`` setting in the config file that must be set +to ``true`` before mailshears will modify the system. Examples -- 2.51.0