OSDN Git Service

fix
[meshio/pymeshio.git] / pymeshio / pmd / writer.py
index 0e7ec0d..8f9c43b 100644 (file)
@@ -1,4 +1,7 @@
 # coding: utf-8\r
+"""\r
+pmd writer\r
+"""\r
 import io\r
 import struct\r
 from .. import common\r
@@ -116,6 +119,19 @@ class Writer(common.BinaryWriter):
 \r
 \r
 def write(ios, model):\r
+    """\r
+    write model to ios.\r
+\r
+    :Parameters:\r
+        ios\r
+            output stream (in io.IOBase)\r
+        model\r
+            pmd model\r
+\r
+    >>> import pymeshio.pmd.writer\r
+    >>> pymeshio.pmd.writer.write(io.open('out.pmd', 'wb'), pmd)\r
+\r
+    """\r
     assert(isinstance(ios, io.IOBase))\r
     assert(isinstance(model, pmd.Model))\r
     writer=Writer(ios)\r