Skip to content

Commit 26c9c0b

Browse files
authored
Update lib.rs doc comments (#168)
* Update lib.rs doc comments * Add Sentence wording
1 parent f9cfe2d commit 26c9c0b

2 files changed

Lines changed: 7 additions & 8 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
Iterators which split strings on Grapheme Cluster or Word boundaries, according
2-
to the [Unicode Standard Annex #29](https://www.unicode.org/reports/tr29/) rules.
1+
Iterators which split strings on Grapheme Cluster, Word, or Sentence boundaries,
2+
according to the
3+
[Unicode Standard Annex #29](https://www.unicode.org/reports/tr29/) rules.
34

45
[![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)
56

src/lib.rs

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,15 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Iterators which split strings on Grapheme Cluster, Word or Sentence boundaries, according
12-
//! to the [Unicode Standard Annex #29](http://www.unicode.org/reports/tr29/) rules.
11+
//! Iterators which split strings on Grapheme Cluster, Word, or Sentence boundaries, according
12+
//! to the [Unicode Standard Annex #29](https://www.unicode.org/reports/tr29/) rules.
1313
//!
1414
//! ```rust
15-
//! extern crate unicode_segmentation;
16-
//!
1715
//! use unicode_segmentation::UnicodeSegmentation;
1816
//!
1917
//! fn main() {
2018
//! let s = "a̐éö̲\r\n";
21-
//! let g = UnicodeSegmentation::graphemes(s, true).collect::<Vec<&str>>();
19+
//! let g = s.graphemes(true).collect::<Vec<&str>>();
2220
//! let b: &[_] = &["a̐", "é", "ö̲", "\r\n"];
2321
//! assert_eq!(g, b);
2422
//!
@@ -46,7 +44,7 @@
4644
//!
4745
//! ```toml
4846
//! [dependencies]
49-
//! unicode-segmentation = "1.9.0"
47+
//! unicode-segmentation = "1"
5048
//! ```
5149
5250
#![deny(missing_docs, unsafe_code)]

0 commit comments

Comments
 (0)