From 7d2827b93db9807300d89bd9fc84caec9e62cc3a Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Wed, 20 Feb 2019 13:23:39 -0500
Subject: [PATCH] Better docs for QueueMixin.stop

---
 src/allmydata/frontends/magic_folder.py | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/allmydata/frontends/magic_folder.py b/src/allmydata/frontends/magic_folder.py
index ad5f3fa50..2cb4f3646 100644
--- a/src/allmydata/frontends/magic_folder.py
+++ b/src/allmydata/frontends/magic_folder.py
@@ -644,12 +644,16 @@ class QueueMixin(HookMixin):
         return extend_filepath(self._local_filepath, relpath_u.split(u"/"))
 
     def stop(self):
+        """
+        Don't process queued items anymore.
+
+        :return Deferred: A ``Deferred`` that fires when processing has
+            completely stopped.
+        """
         d = self._processing
-        # Speed up shutdown
         self._processing_loop.stop()
         self._processing = None
         self._processing_loop = None
-        # wait for processing loop to actually exit
         return d
 
     def _begin_processing(self, res):