Skip to content

Commit

Permalink
Document Unicode version in README and lib.rs
Browse files Browse the repository at this point in the history
  • Loading branch information
lopopolo committed Nov 15, 2021
1 parent 747fd84 commit 77f373e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,10 @@ All features are enabled by default.
This crate requires at least Rust 1.52.0. This version can be bumped in minor
releases.

### Unicode Version Updates
## Unicode Version

Focaccia implements Unicode case folding with the Unicode 14.0.0 case folding
ruleset.

Each new release of Unicode may bring updates to the `CaseFolding.txt` which is
the source for the folding mappings in this crate. Updates to the case folding
Expand Down
9 changes: 9 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,15 @@
//! - **std** - Enable linking to the [Rust Standard Library]. Enabling this
//! feature adds [`Error`] implementations to error types in this crate.
//!
//! # Unicode Version
//!
//! Focaccia implements Unicode case folding with the Unicode 14.0.0 case folding
//! ruleset.
//!
//! Each new release of Unicode may bring updates to the `CaseFolding.txt` which is
//! the source for the folding mappings in this crate. Updates to the case folding
//! rules will be accompanied with a minor version bump.
//!
//! [Unicode case folding]: https://www.w3.org/International/wiki/Case_folding
//! [`Ordering`]: core::cmp::Ordering
//! [dotted and dotless I]: https://en.wikipedia.org/wiki/Dotted_and_dotless_I
Expand Down

0 comments on commit 77f373e

Please sign in to comment.