From 77f373e1deb9c765ce93ff290aca09614ba66c9f Mon Sep 17 00:00:00 2001 From: Ryan Lopopolo Date: Mon, 15 Nov 2021 10:44:36 -0800 Subject: [PATCH] Document Unicode version in README and lib.rs --- README.md | 5 ++++- src/lib.rs | 9 +++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 47b92876..8c9b4b9f 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/src/lib.rs b/src/lib.rs index 9d9ba49f..2f6b5908 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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