From fdda8c4e5d5009eb7bdeb7b556b84fe2dce2d850 Mon Sep 17 00:00:00 2001 From: Irina Truong Date: Sat, 4 Feb 2017 18:56:20 -0800 Subject: [PATCH] Added documantation about tabulate's number formatting. Connect #617. --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) 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