From 4f84320e464aadd765c0926b2cf12853ef1fc22b Mon Sep 17 00:00:00 2001 From: Tsuyoshi Hombashi Date: Mon, 18 Feb 2019 21:57:26 +0900 Subject: [PATCH] Update README --- README.rst | 15 +++++++++++---- docs/make_readme.py | 2 +- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 5ca35da7..73eb2b93 100644 --- a/README.rst +++ b/README.rst @@ -46,7 +46,7 @@ Features - Source code - JavaScript code (Definition of a nested list variable) - `NumPy `__ (Definition of a `numpy.array `__ variable) - - `Pandas `__ (Definition of a `pandas.DataFrame `__ variable) + - `Pandas `__ (Definition of a `pandas.DataFrame `__ variable) - Python code (Definition of a nested list variable) - Space aligned values - `TOML `__ @@ -63,9 +63,16 @@ Features - Text alignment - Font size/weight - Thousand separator for numbers: e.g. ``1,000``/``1 000`` +- Configure ouput: + - Write table to a stream such as a file/standard-output/string-buffer/Jupyter-Notebook + - Get rendered tabular text +- Data source + - nested list + - CSV + - `pandas.DataFrame `__ + - `pandas.Series `__ + - etc. - Multibyte character support -- Write table to a stream such as a file/standard-output/string-buffer/Jupyter-Notebook -- Get rendered tabular text - ANSI color support Examples @@ -345,7 +352,7 @@ Write a markdown table from a space-separated values Get rendered tabular text as str ---------------------------------- ``dumps`` method returns rendered tabular text. -``dumps`` available only for text format writers. +``dumps`` only available for text format writers. :Sample Code: .. code-block:: python diff --git a/docs/make_readme.py b/docs/make_readme.py index b073cb65..cf772058 100644 --- a/docs/make_readme.py +++ b/docs/make_readme.py @@ -62,7 +62,7 @@ def write_examples(maker): maker.set_indent_level(1) maker.write_chapter("Get rendered tabular text as str") - maker.write_file(examples_root.joinpath("dump", "dumps.txt")) + maker.write_file(examples_root.joinpath("output", "dump", "dumps.txt")) maker.set_indent_level(1) maker.write_chapter("Configure table styles")