Skip to content

Commit

Permalink
Moved the crate documentation to mirror the readme #13.
Browse files Browse the repository at this point in the history
  • Loading branch information
Teh-Bobo committed Aug 12, 2023
1 parent 485af20 commit 4cc4cad
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 17 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "unicode_titlecase"
version = "2.2.0"
version = "2.2.1"
edition = "2021"
authors = ["Carl Raffaele"]
license = "MIT OR Apache-2.0"
Expand Down
17 changes: 1 addition & 16 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
//! This crate is an implementation of the Unicode Title Casing algorithm. It implements a trait
//! on [char] and [str] that adds title case handling methods. These methods are very similar to how
//! the std library currently handles uppercase and lowercase.
#![doc = include_str!("../README.md")]
#![no_std]
#![deny(missing_docs)]
#![deny(rustdoc::missing_doc_code_examples)]
Expand Down Expand Up @@ -720,16 +717,4 @@ mod tests {
last = *cp;
});
}
}

// Thanks to https://github.com/rust-lang/cargo/issues/383#issuecomment-720873790
#[cfg(doctest)]
mod test_readme {
macro_rules! external_doc_test {
($x:expr) => {
#[doc = $x]
extern {}
};
}
external_doc_test!(include_str!("../README.md"));
}

0 comments on commit 4cc4cad

Please sign in to comment.