wrote FAM docs

1 files changed, 8 insertions, 5 deletions

diff --git a/src/lib/Bcfg2/Server/FileMonitor/Pseudo.py b/src/lib/Bcfg2/Server/FileMonitor/Pseudo.py
index 9062cbfd8..24cd099d0 100644
--- a/src/lib/Bcfg2/Server/FileMonitor/Pseudo.py
+++ b/src/lib/Bcfg2/Server/FileMonitor/Pseudo.py
@@ -1,17 +1,20 @@
-""" Pseudo provides static monitor support for file alteration events """
+""" Pseudo provides static monitor support for file alteration events.
+That is, it only produces "exists" and "endExist" events and does not
+monitor for ongoing changes. """
 
 import os
 from Bcfg2.Server.FileMonitor import FileMonitor, Event
 
 
 class Pseudo(FileMonitor):
-    """ file monitor that only produces events on server startup and
-    doesn't actually monitor at all """
+    """ File monitor that only produces events on server startup and
+    doesn't actually monitor for ongoing changes at all. """
 
-    __priority__ = 99
+    #: The ``Pseudo`` monitor should only be used if no other FAM
+    #: backends are available.
+    __priority__ = 1
 
     def AddMonitor(self, path, obj, handleID=None):
-        """add a monitor to path, installing a callback to obj.HandleEvent"""
         if handleID is None:
             handleID = len(list(self.handles.keys()))
         self.events.append(Event(handleID, path, 'exists'))