X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/mLib-python/blobdiff_plain/376ad06df03e59ebf0796b2f475417150e82252d..HEAD:/fwatch.pyx

diff --git a/fwatch.pyx b/fwatch.pyx
index d058976..eedb872 100644
--- a/fwatch.pyx
+++ b/fwatch.pyx
@@ -1,31 +1,34 @@
-# -*-pyrex-*-
-#
-# $Id$
-#
-# Watching files for changes
-#
-# (c) 2007 Straylight/Edgeware
-#
+### -*-pyrex-*-
+###
+### Watching files for changes
+###
+### (c) 2007 Straylight/Edgeware
+###
 
-#----- Licensing notice -----------------------------------------------------
-#
-# This file is part of the Python interface to mLib.
-#
-# mLib/Python is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# mLib/Python is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with mLib/Python; if not, write to the Free Software Foundation,
-# Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+###----- Licensing notice ---------------------------------------------------
+###
+### This file is part of the Python interface to mLib.
+###
+### mLib/Python is free software; you can redistribute it and/or modify
+### it under the terms of the GNU General Public License as published by
+### the Free Software Foundation; either version 2 of the License, or
+### (at your option) any later version.
+###
+### mLib/Python is distributed in the hope that it will be useful,
+### but WITHOUT ANY WARRANTY; without even the implied warranty of
+### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+### GNU General Public License for more details.
+###
+### You should have received a copy of the GNU General Public License
+### along with mLib/Python; if not, write to the Free Software Foundation,
+### 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):
@@ -39,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)
@@ -46,4 +50,4 @@ cdef class FWatch:
       rc = fwatch_updatefd(&me.fw, _getfd(me.file))
     return rc
 
-#----- That's all, folks ----------------------------------------------------
+###----- That's all, folks --------------------------------------------------