Skip to content

Commit

Permalink
Remove mentions of accounting in force_sign=
Browse files Browse the repository at this point in the history
  • Loading branch information
rich-iannone committed Aug 26, 2024
1 parent 7365aaa commit 54fd8dd
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 20 deletions.
15 changes: 5 additions & 10 deletions great_tables/_formats.py
Original file line number Diff line number Diff line change
Expand Up @@ -231,8 +231,7 @@ def fmt_number(
force_sign
Should the positive sign be shown for positive values (effectively showing a sign for all
values except zero)? If so, use `True` for this option. The default is `False`, where only
negative numbers will display a minus sign. This option is disregarded when using accounting
notation with `accounting = True`.
negative numbers will display a minus sign.
locale
An optional locale identifier that can be used for formatting values according the locale's
rules. Examples include `"en"` for English (United States) and `"fr"` for French (France).
Expand Down Expand Up @@ -412,8 +411,7 @@ def fmt_integer(
force_sign
Should the positive sign be shown for positive values (effectively showing a sign for all
values except zero)? If so, use `True` for this option. The default is `False`, where only
negative numbers will display a minus sign. This option is disregarded when using accounting
notation with `accounting = True`.
negative numbers will display a minus sign.
locale
An optional locale identifier that can be used for formatting values according the locale's
rules. Examples include `"en"` for English (United States) and `"fr"` for French (France).
Expand Down Expand Up @@ -865,8 +863,7 @@ def fmt_percent(
force_sign
Should the positive sign be shown for positive values (effectively showing a sign for all
values except zero)? If so, use `True` for this option. The default is `False`, where only
negative numbers will display a minus sign. This option is disregarded when using accounting
notation with `accounting = True`.
negative numbers will display a minus sign.
placement
This option governs the placement of the percent sign. This can be either be `"right"` (the
default) or `"left"`.
Expand Down Expand Up @@ -1089,8 +1086,7 @@ def fmt_currency(
force_sign
Should the positive sign be shown for positive values (effectively showing a sign for all
values except zero)? If so, use `True` for this option. The default is `False`, where only
negative numbers will display a minus sign. This option is disregarded when using accounting
notation with `accounting = True`.
negative numbers will display a minus sign.
placement
The placement of the currency symbol. This can be either be `"left"` (as in `"$450"`) or
`"right"` (which yields `"450$"`).
Expand Down Expand Up @@ -1437,8 +1433,7 @@ def fmt_bytes(
force_sign
Should the positive sign be shown for positive values (effectively showing a sign for all
values except zero)? If so, use `True` for this option. The default is `False`, where only
negative numbers will display a minus sign. This option is disregarded when using accounting
notation with `accounting = True`.
negative numbers will display a minus sign.
incl_space
An option for whether to include a space between the value and the currency symbol. The
default is to not introduce a space character.
Expand Down
15 changes: 5 additions & 10 deletions great_tables/_formats_vals.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,7 @@ def val_fmt_number(
force_sign
Should the positive sign be shown for positive values (effectively showing a sign for all
values except zero)? If so, use `True` for this option. The default is `False`, where only
negative numbers will display a minus sign. This option is disregarded when using accounting
notation with `accounting = True`.
negative numbers will display a minus sign.
locale
An optional locale identifier that can be used for formatting values according the locale's
rules. Examples include `"en"` for English (United States) and `"fr"` for French (France).
Expand Down Expand Up @@ -219,8 +218,7 @@ def val_fmt_integer(
force_sign
Should the positive sign be shown for positive values (effectively showing a sign for all
values except zero)? If so, use `True` for this option. The default is `False`, where only
negative numbers will display a minus sign. This option is disregarded when using accounting
notation with `accounting = True`.
negative numbers will display a minus sign.
locale
An optional locale identifier that can be used for formatting values according the locale's
rules. Examples include `"en"` for English (United States) and `"fr"` for French (France).
Expand Down Expand Up @@ -447,8 +445,7 @@ def val_fmt_percent(
force_sign
Should the positive sign be shown for positive values (effectively showing a sign for all
values except zero)? If so, use `True` for this option. The default is `False`, where only
negative numbers will display a minus sign. This option is disregarded when using accounting
notation with `accounting = True`.
negative numbers will display a minus sign.
placement
This option governs the placement of the percent sign. This can be either be `"right"` (the
default) or `"left"`.
Expand Down Expand Up @@ -568,8 +565,7 @@ def val_fmt_currency(
force_sign
Should the positive sign be shown for positive values (effectively showing a sign for all
values except zero)? If so, use `True` for this option. The default is `False`, where only
negative numbers will display a minus sign. This option is disregarded when using accounting
notation with `accounting = True`.
negative numbers will display a minus sign.
placement
The placement of the currency symbol. This can be either be `"left"` (as in `"$450"`) or
`"right"` (which yields `"450$"`).
Expand Down Expand Up @@ -726,8 +722,7 @@ def val_fmt_bytes(
force_sign
Should the positive sign be shown for positive values (effectively showing a sign for all
values except zero)? If so, use `True` for this option. The default is `False`, where only
negative numbers will display a minus sign. This option is disregarded when using accounting
notation with `accounting = True`.
negative numbers will display a minus sign.
incl_space
An option for whether to include a space between the value and the currency symbol. The
default is to not introduce a space character.
Expand Down

0 comments on commit 54fd8dd

Please sign in to comment.