Skip to content

gh-128185: Align the grammar of the Decimal string constructor with float's #128315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

gh-128185: Align the grammar of the Decimal string constructor with float's #128315

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5cbf217
Align the grammar of the `Decimal` string constructor with `float`'s
HarryLHW Dec 28, 2024
f5468ad
Use a production list
HarryLHW Dec 28, 2024
b80f68f
Update Doc/library/decimal.rst
HarryLHW Dec 28, 2024
9646cd5
Use `_` to separate words
HarryLHW Dec 28, 2024
f263f6d
revert 'as well as underscores throughout'
HarryLHW Dec 28, 2024
1e13f7c
Revert the grammar change.
HarryLHW Dec 30, 2024
2cd8e6b
Update Doc/library/decimal.rst
HarryLHW Dec 31, 2024
015abbe
Update Doc/library/decimal.rst
HarryLHW Dec 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions Doc/library/decimal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,18 +350,19 @@ Decimal objects
*value* can be an integer, string, tuple, :class:`float`, or another :class:`Decimal`
object. If no *value* is given, returns ``Decimal('0')``. If *value* is a
string, it should conform to the decimal numeric string syntax after leading
and trailing whitespace characters, as well as underscores throughout, are removed::

sign ::= '+' | '-'
digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
indicator ::= 'e' | 'E'
digits ::= digit [digit]...
decimal-part ::= digits '.' [digits] | ['.'] digits
exponent-part ::= indicator [sign] digits
infinity ::= 'Infinity' | 'Inf'
nan ::= 'NaN' [digits] | 'sNaN' [digits]
numeric-value ::= decimal-part [exponent-part] | infinity
numeric-string ::= [sign] numeric-value | [sign] nan
and trailing whitespace characters are removed:

.. productionlist:: decimal
sign: "+" | "-"
digit: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
indicator: "e" | "E"
digits: (`digit` | "_")* `digit` (`digit` | "_")*
decimalpart: `digits` "." [`digits`] | ["."] `digits`
exponentpart: indicator [sign] digits
infinity: "Infinity" | "Inf"
nan: "NaN" [`digits`] | "sNaN" [`digits`]
numericvalue: `decimalpart` [`exponentpart`] | `infinity`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do Sphinx production lists support numeric-value instead or should it be without any weird symbol? if not, use _ instead of - to separate words.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sphinx does not support -, but it does support _.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yet another thing I should perhaps add to my list of things to fix upstream... Thanks for checking.

numericstring: [`sign`] `numericvalue` | [`sign`] `nan`

Other Unicode decimal digits are also permitted where ``digit``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here you can reference grammar term instead. Though, this may add a conflict with #128323, so - you can include that change here as well.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like this:

   Other Unicode decimal digits are also permitted where :token:`~decimal.digit`

appears above. These include decimal digits from various other
Expand Down
Loading