search

posit-dev / great-tables

Make awesome display tables using Python.
https://posit-dev.github.io/great-tables/
MIT License
1.44k stars 50 forks source link

Remove mentions of 'Accounting' format in docs #241

Open Yasin197 opened 3 months ago

Yasin197 commented 3 months ago

In the docs it mentions numbers will be formatted if accounting=True.

So I would expect negative numbers would be represented in accounting terms e.g. a cell with value of 2 would be represented as (2)

I don't see a clean example on how to use this API?

rich-iannone commented 2 months ago

Thanks for reporting this. I had a look at the documentation and this appears to be a mistake. There is the repeated line:

"This option is disregarded when using notation with 'accounting = True'"

We don't yet have accounting notation implemented in the relevant numeric formatting methods.

I think the best course of action right now is to remove all mention of this in the docs and create an issue that tracks the implementation of accounting notation.