update document

[meshio/pymeshio.git] / pymeshio / pmx / writer.py

diff --git a/pymeshio/pmx/writer.py b/pymeshio/pmx/writer.py
index f823985..3ad89ca 100644 (file)
--- a/pymeshio/pmx/writer.py
+++ b/pymeshio/pmx/writer.py
@@ -259,8 +259,21 @@ class Writer(common.BinaryWriter):
             self.write_vector3(j.spring_constant_rotation)\r
 \r
 \r
-def write(ios, model, text_encoding=1):\r
-    """pmx書き込み\r
+def write(ios, model, text_encoding=0):\r
+    """\r
+    write model to ios.\r
+\r
+    :Parameters:\r
+        ios\r
+            output stream (in io.IOBase)\r
+        model\r
+            pmx model\r
+        text_encoding\r
+            text field encoding (0: UTF16, 1:UTF-8).\r
+\r
+    >>> import pymeshio.pmx.writer\r
+    >>> pymeshio.pmx.writer.write(io.open('out.pmx', 'wb'))\r
+\r
     """\r
     assert(isinstance(ios, io.IOBase))\r
     assert(isinstance(model, pmx.Model))\r