*.pyx: Add some rather laconic docstrings.

[mLib-python] / sel-base.pyx

diff --git a/sel-base.pyx b/sel-base.pyx
index e7b4fbe7329a9a6a51132cc95772834de8fb3f3b..64e8d08cb32bf52a31693e4fdf44f4d275ef1252 100644 (file)
--- a/sel-base.pyx
+++ b/sel-base.pyx
@@ -1,36 +1,35 @@
-# -*-pyrex-*-
-#
-# $Id$
-#
-# Select basic stuff
-#
-# (c) 2005 Straylight/Edgeware
-#
+### -*-pyrex-*-
+###
+### Select basic stuff
+###
+### (c) 2005 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 sel_state _sel
 
 def select():
+  """select(): wait for I/O and/or timeouts"""
   if sel_select(&_sel) and errno != EINTR and errno != EAGAIN:
     _oserror()
 
 sel_init(&_sel)
 
-#----- That's all, folks ----------------------------------------------------
+###----- That's all, folks --------------------------------------------------