Skip to content

Commit 5a5aaca

Browse files
committed
Document LTR vs RTL wrt trim_*
The doc part of #30459
1 parent 0486e12 commit 5a5aaca

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

src/libcollections/str.rs

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1515,6 +1515,13 @@ impl str {
15151515
/// 'Whitespace' is defined according to the terms of the Unicode Derived
15161516
/// Core Property `White_Space`.
15171517
///
1518+
/// # Text directionality
1519+
///
1520+
/// A string is a sequence of bytes. 'Left' in this context means the first
1521+
/// position of that byte string; for a language like Arabic or Hebrew
1522+
/// which are 'right to left' rather than 'left to right', this will be
1523+
/// the _right_ side, not the left.
1524+
///
15181525
/// # Examples
15191526
///
15201527
/// Basic usage:
@@ -1534,6 +1541,13 @@ impl str {
15341541
/// 'Whitespace' is defined according to the terms of the Unicode Derived
15351542
/// Core Property `White_Space`.
15361543
///
1544+
/// # Text directionality
1545+
///
1546+
/// A string is a sequence of bytes. 'Right' in this context means the last
1547+
/// position of that byte string; for a language like Arabic or Hebrew
1548+
/// which are 'right to left' rather than 'left to right', this will be
1549+
/// the _left_ side, not the right.
1550+
///
15371551
/// # Examples
15381552
///
15391553
/// Basic usage:
@@ -1588,6 +1602,13 @@ impl str {
15881602
///
15891603
/// [`char`]: primitive.char.html
15901604
///
1605+
/// # Text directionality
1606+
///
1607+
/// A string is a sequence of bytes. 'Left' in this context means the first
1608+
/// position of that byte string; for a language like Arabic or Hebrew
1609+
/// which are 'right to left' rather than 'left to right', this will be
1610+
/// the _right_ side, not the left.
1611+
///
15911612
/// # Examples
15921613
///
15931614
/// Basic usage:
@@ -1612,6 +1633,13 @@ impl str {
16121633
///
16131634
/// [`char`]: primitive.char.html
16141635
///
1636+
/// # Text directionality
1637+
///
1638+
/// A string is a sequence of bytes. 'Right' in this context means the last
1639+
/// position of that byte string; for a language like Arabic or Hebrew
1640+
/// which are 'right to left' rather than 'left to right', this will be
1641+
/// the _left_ side, not the right.
1642+
///
16151643
/// # Examples
16161644
///
16171645
/// Simple patterns:

0 commit comments

Comments
 (0)