Skip to content

Update lib.rs doc comments #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Manishearth merged 2 commits into from
Mar 30, 2026
+7 −8
Merged

Update lib.rs doc comments #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ade845
Update lib.rs doc comments
atouchet Mar 30, 2026
d26de0a
Add Sentence wording
atouchet Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Iterators which split strings on Grapheme Cluster or Word boundaries, according
to the [Unicode Standard Annex #29](https://www.unicode.org/reports/tr29/) rules.
Iterators which split strings on Grapheme Cluster, Word, or Sentence boundaries,
according to the
[Unicode Standard Annex #29](https://www.unicode.org/reports/tr29/) rules.

[![Build Status](https://github.com/unicode-rs/unicode-segmentation/actions/workflows/rust.yml/badge.svg)](https://github.com/unicode-rs/unicode-segmentation/actions/workflows/rust.yml)

Expand Down
10 changes: 4 additions & 6 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,15 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Iterators which split strings on Grapheme Cluster, Word or Sentence boundaries, according

@atouchet atouchet Mar 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This wording was added in 7ac6f29 for lib.rs but not the readme. Is the version with "Sentence" better to use or should the readme version be used here?

@atouchet atouchet Mar 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opted to change this in the readme instead.

//! to the [Unicode Standard Annex #29](http://www.unicode.org/reports/tr29/) rules.
//! Iterators which split strings on Grapheme Cluster, Word, or Sentence boundaries, according
//! to the [Unicode Standard Annex #29](https://www.unicode.org/reports/tr29/) rules.
//!
//! ```rust
//! extern crate unicode_segmentation;
//!
//! use unicode_segmentation::UnicodeSegmentation;
//!
//! fn main() {
//! let s = "a̐éö̲\r\n";
//! let g = UnicodeSegmentation::graphemes(s, true).collect::<Vec<&str>>();
//! let g = s.graphemes(true).collect::<Vec<&str>>();
//! let b: &[_] = &["a̐", "é", "ö̲", "\r\n"];
//! assert_eq!(g, b);
//!
Expand Down Expand Up @@ -46,7 +44,7 @@
//!
//! ```toml
//! [dependencies]
//! unicode-segmentation = "1.9.0"
//! unicode-segmentation = "1"
//! ```

#![deny(missing_docs, unsafe_code)]
Expand Down
Loading