Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thombashi committed Feb 18, 2019
1 parent 0c56b22 commit 4f84320
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
15 changes: 11 additions & 4 deletions README.rst
Expand Up @@ -46,7 +46,7 @@ Features
- Source code
- JavaScript code (Definition of a nested list variable)
- `NumPy <https://www.numpy.org/>`__ (Definition of a `numpy.array <https://docs.scipy.org/doc/numpy/reference/generated/numpy.array.html>`__ variable)
- `Pandas <https://pandas.pydata.org/>`__ (Definition of a `pandas.DataFrame <https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.html>`__ variable)
- `Pandas <https://pandas.pydata.org/>`__ (Definition of a `pandas.DataFrame <https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html>`__ variable)
- Python code (Definition of a nested list variable)
- Space aligned values
- `TOML <https://github.com/toml-lang/toml>`__
Expand All @@ -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 <https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html>`__
- `pandas.Series <https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Series.html>`__
- 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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/make_readme.py
Expand Up @@ -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")
Expand Down

0 comments on commit 4f84320

Please sign in to comment.