update document

[meshio/pymeshio.git] / pymeshio / mqo / reader.py

diff --git a/pymeshio/mqo/reader.py b/pymeshio/mqo/reader.py
index a5ada0b..47cb578 100644 (file)
--- a/pymeshio/mqo/reader.py
+++ b/pymeshio/mqo/reader.py
@@ -159,12 +159,25 @@ class Reader(object):
 \r
 \r
 def read_from_file(path):\r
+    """\r
+    read from file path, then return the pymeshio.mqo.Model.\r
+\r
+    :Parameters:\r
+      path\r
+        file path\r
+    """\r
     with io.open(path, 'rb') as ios:\r
         return read(ios)\r
 \r
 \r
 def read(ios):\r
-    print(type(ios), ios)\r
+    """\r
+    read from ios, then return the pymeshio.mqo.Model.\r
+\r
+    :Parameters:\r
+      ios\r
+        input stream (in io.IOBase)\r
+    """\r
     assert(isinstance(ios, io.IOBase))\r
     reader=Reader(ios)\r
     model=mqo.Model()\r