Skip to content

Commit 0b13808

Browse files
Add note on correct_defective_ccs usage
1 parent d4decae commit 0b13808

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

src/correct_ccs.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ impl CcsKind {
4444
/// For the purposes of this iterator, private use characters,
4545
/// as well as unassigned codepoints other than noncharacters,
4646
/// are considered valid base characters,
47-
/// so combining character sequences that start with such will not be modified.
47+
/// so combining character sequences that follow such will not be modified.
4848
///
4949
/// In addition, combining character sequences that consist entirely of `Default_Ignorable_Code_Point`s
5050
/// will not be modified. (Because of this, this iterator may buffer up to the entire length of its input;

src/lib.rs

+6-2
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,13 @@ pub trait UnicodeNormalization<I: Iterator<Item = char>> {
133133

134134
/// An iterator over the string with
135135
/// [defective combining character sequences](https://www.unicode.org/versions/Unicode15.0.0/UnicodeStandard-15.0.pdf#I6.1.36487)
136-
/// corrected via the insertion of U+00A0 NO-BREAK SPACE.
136+
/// corrected via the insertion of U+00A0 NO-BREAK SPACE in front of them.
137137
///
138-
/// Sequences starting with a private use character or an unassigned codepoint that is not a noncharacter
138+
/// This helps ensure that the sequences will be displayed correctly and consistently,
139+
/// with the correct advance width,
140+
/// in diverse contexts (for example, when printed to a terminal).
141+
///
142+
/// Sequences following a private use character or an unassigned codepoint that is not a noncharacter
139143
/// are not corrected. Additionally, combining character sequences consisting entirely of
140144
/// [default-ignorable code points](https://www.unicode.org/versions/Unicode15.0.0/UnicodeStandard-15.0.pdf#I8.1.40715)
141145
/// are also left untouched. Handling this last case may require the iterator

0 commit comments

Comments
 (0)