Skip to content

Commit 6892982

Browse files
TheNeikosGeal
authored andcommitted
Clarify the return value of recognize_float_parts
1 parent 5074124 commit 6892982

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

src/number/complete.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1460,7 +1460,10 @@ where
14601460
))(input)
14611461
}
14621462

1463-
/// Recognizes a floating point number in text format and returns the integer, fraction and exponent parts of the input data
1463+
/// Recognizes a floating point number in text format
1464+
///
1465+
/// It returns a tuple of (`sign`, `integer part`, `fraction part` and `exponent`) of the input
1466+
/// data.
14641467
///
14651468
/// *Complete version*: Can parse until the end of input.
14661469
///

src/number/streaming.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1429,7 +1429,10 @@ where
14291429
))(input)
14301430
}
14311431

1432-
/// Recognizes a floating point number in text format and returns the integer, fraction and exponent parts of the input data
1432+
/// Recognizes a floating point number in text format
1433+
///
1434+
/// It returns a tuple of (`sign`, `integer part`, `fraction part` and `exponent`) of the input
1435+
/// data.
14331436
///
14341437
/// *Streaming version*: Will return `Err(nom::Err::Incomplete(_))` if there is not enough data.
14351438
///

0 commit comments

Comments
 (0)