summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAmjith Ramanujam <amjith.r@gmail.com>2017-02-04 19:42:05 -0800
committerGitHub <noreply@github.com>2017-02-04 19:42:05 -0800
commit4ad7c0f11b92348fe5b5b8d6a67c62f80e1d05d5 (patch)
tree7394294c3c56b65120e3387860753b54dad6c2e1
parent2a83436f14dd8c9d4dbad4889c530b5398463dfc (diff)
parentfdda8c4e5d5009eb7bdeb7b556b84fe2dce2d850 (diff)
Merge pull request #638 from dbcli/bugfix/document-tabulate-number-formatting
Added documantation about tabulate's number formatting. Connect #617.
-rw-r--r--README.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 083ae967..df44a978 100644
--- a/README.rst
+++ b/README.rst
@@ -66,6 +66,10 @@ The `pgcli` is written using prompt_toolkit_.
* Config file is automatically created at ``~/.config/pgcli/config`` at first launch.
* Primitive support for ``psql`` back-slash commands.
* Pretty prints tabular data.
+ Note: `pgcli` uses [tabulate](https://github.com/dbcli/pgcli/blob/master/pgcli/packages/tabulate.py)
+ package to pretty-print tables. This library does smart formatting of numbers,
+ which can sometimes lead to unexpected output. See
+ [this issue](https://github.com/dbcli/pgcli/issues/617) for more details.
.. _prompt_toolkit: https://github.com/jonathanslenders/python-prompt-toolkit