diff options
| author | Mazdak Farrokhzad <twingoow@gmail.com> | 2019-01-25 01:36:57 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-01-25 01:36:57 +0100 |
| commit | 284e1a86c0e3e3aed269b5c545d3e9dc78bafa8a (patch) | |
| tree | f24541e91145405bb13dce6b75754fa98d107208 /src/libcore | |
| parent | 278067d34d1535a840cf9c99bcb8b538bf5b109a (diff) | |
| parent | 8af02faab8434d63b6eedb7b5e8f47d0ff0b5e6c (diff) | |
| download | rust-284e1a86c0e3e3aed269b5c545d3e9dc78bafa8a.tar.gz rust-284e1a86c0e3e3aed269b5c545d3e9dc78bafa8a.zip | |
Rollup merge of #56217 - frewsxcv:frewsxcv-float-parse, r=QuietMisdreavus
Add grammar in docs for {f32,f64}::from_str, mention known bug.
- Original bug about documenting grammar
- https://github.com/rust-lang/rust/issues/32243
- Known bug with parsing
- https://github.com/rust-lang/rust/issues/31407
Diffstat (limited to 'src/libcore')
| -rw-r--r-- | src/libcore/num/dec2flt/mod.rs | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/src/libcore/num/dec2flt/mod.rs b/src/libcore/num/dec2flt/mod.rs index 58b196a6eac..14a912872be 100644 --- a/src/libcore/num/dec2flt/mod.rs +++ b/src/libcore/num/dec2flt/mod.rs @@ -112,11 +112,35 @@ macro_rules! from_str_float_impl { /// * '2.5E10', or equivalently, '2.5e10' /// * '2.5E-10' /// * '5.' - /// * '.5', or, equivalently, '0.5' + /// * '.5', or, equivalently, '0.5' /// * 'inf', '-inf', 'NaN' /// /// Leading and trailing whitespace represent an error. /// + /// # Grammar + /// + /// All strings that adhere to the following [EBNF] grammar + /// will result in an [`Ok`] being returned: + /// + /// ```txt + /// Float ::= Sign? ( 'inf' | 'NaN' | Number ) + /// Number ::= ( Digit+ | + /// Digit+ '.' Digit* | + /// Digit* '.' Digit+ ) Exp? + /// Exp ::= [eE] Sign? Digit+ + /// Sign ::= [+-] + /// Digit ::= [0-9] + /// ``` + /// + /// [EBNF]: https://www.w3.org/TR/REC-xml/#sec-notation + /// + /// # Known bugs + /// + /// In some situations, some strings that should create a valid float + /// instead return an error. See [issue #31407] for details. + /// + /// [issue #31407]: https://github.com/rust-lang/rust/issues/31407 + /// /// # Arguments /// /// * src - A string |
