X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/mLib-python/blobdiff_plain/a19eaede18c9176b382df01e4f6c6e5c04a87d0f..addc0c3760b565ead630bd67cc038b31954b9284:/fwatch.pyx

diff --git a/fwatch.pyx b/fwatch.pyx
index 2e484cd..eedb872 100644
--- a/fwatch.pyx
+++ b/fwatch.pyx
@@ -24,6 +24,11 @@
 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
 cdef class FWatch:
+  """
+  FWatch(FILE): watch FILE for changes
+
+  FILE may be a string, file descriptor, or an object with a `fileno' method.
+  """
   cdef fwatch fw
   cdef public file
   def __cinit__(me, file):
@@ -37,6 +42,7 @@ cdef class FWatch:
       fwatch_initfd(&me.fw, _getfd(file))
     me.file = file
   def update(me):
+    """FW.update() -> RC: nonzero if the file has changed state"""
     cdef int rc
     if isinstance(me.file, str):
       rc = fwatch_update(&me.fw, me.file)