Update documentation for trim* and is_whitespace to include newlines

This commit is contained in:
Deadbeef 2022-04-06 11:03:36 +10:00
parent 949b98cab8
commit 9a2d0e53f1
No known key found for this signature in database
GPG Key ID: 6D017A96D8E6C2F9
2 changed files with 11 additions and 8 deletions

View File

@ -804,6 +804,9 @@ impl char {
/// ```
/// assert!(' '.is_whitespace());
///
/// // line break
/// assert!('\n'.is_whitespace());
///
/// // a non-breaking space
/// assert!('\u{A0}'.is_whitespace());
///

View File

@ -1832,14 +1832,14 @@ impl str {
/// Returns a string slice with leading and trailing whitespace removed.
///
/// 'Whitespace' is defined according to the terms of the Unicode Derived
/// Core Property `White_Space`.
/// Core Property `White_Space`, which includes newlines.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// let s = " Hello\tworld\t";
/// let s = "\n Hello\tworld\t\n";
///
/// assert_eq!("Hello\tworld", s.trim());
/// ```
@ -1855,7 +1855,7 @@ impl str {
/// Returns a string slice with leading whitespace removed.
///
/// 'Whitespace' is defined according to the terms of the Unicode Derived
/// Core Property `White_Space`.
/// Core Property `White_Space`, which includes newlines.
///
/// # Text directionality
///
@ -1869,8 +1869,8 @@ impl str {
/// Basic usage:
///
/// ```
/// let s = " Hello\tworld\t";
/// assert_eq!("Hello\tworld\t", s.trim_start());
/// let s = "\n Hello\tworld\t\n";
/// assert_eq!("Hello\tworld\t\n", s.trim_start());
/// ```
///
/// Directionality:
@ -1894,7 +1894,7 @@ impl str {
/// Returns a string slice with trailing whitespace removed.
///
/// 'Whitespace' is defined according to the terms of the Unicode Derived
/// Core Property `White_Space`.
/// Core Property `White_Space`, which includes newlines.
///
/// # Text directionality
///
@ -1908,8 +1908,8 @@ impl str {
/// Basic usage:
///
/// ```
/// let s = " Hello\tworld\t";
/// assert_eq!(" Hello\tworld", s.trim_end());
/// let s = "\n Hello\tworld\t\n";
/// assert_eq!("\n Hello\tworld", s.trim_end());
/// ```
///
/// Directionality: