Update docstrings

thombashi · Oct 8, 2023 · b0f3c97 · b0f3c97
1 parent dca9d00
commit b0f3c97
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 6 deletions.
diff --git a/pytablewriter/writer/_table_writer.py b/pytablewriter/writer/_table_writer.py
@@ -810,7 +810,14 @@ def from_writer(
         self, writer: "AbstractTableWriter", is_overwrite_table_name: bool = True
     ) -> None:
         """
-        Set tabular attributes to the writer from another table writer class instance.
+        Copy attributes from another table writer class instance.
+
+        Args:
+            writer (pytablewriter.writer.AbstractTableWriter):
+                Another table writer instance.
+            is_overwrite_table_name (bool, optional):
+                Overwrite the table name of the writer with the table name of the ``writer``.
+                Defaults to |True|.
         """
 
         self.__clear_preprocess()

diff --git a/pytablewriter/writer/text/_markdown.py b/pytablewriter/writer/text/_markdown.py
@@ -44,8 +44,8 @@ class MarkdownTableWriter(IndentationTextTableWriter):
     """
     A table writer class for Markdown format.
 
-        :Example:
-            :ref:`example-markdown-table-writer`
+    Example:
+        :ref:`example-markdown-table-writer`
     """
 
     FORMAT_NAME = "markdown"
@@ -130,11 +130,11 @@ def write_table(self, **kwargs: Any) -> None:
 
         Args:
             flavor (Optional[str]):
-                possible flavors are:
+                possible flavors are as follows (case insensitive):
 
                     - ``"CommonMark"``
-                    - ``"github"``
-                    - ``"gfm"`` (alias of ``"github"``)
+                    - ``"gfm"``
+                    - ``"github"`` (alias of ``"gfm"``)
                     - ``kramdown``
                     - ``Jekyll`` (alias of ``"kramdown"``)