Commit03fbc93

committed

Add example to head of doc comment

1 parent3ab4c84 commit03fbc93Copy full SHA for 03fbc93

File tree

+23

-4

lines changed

+23

-4

lines changed

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ Converters of troublesome characters included in Japanese texts.`
`8`	`8`	`- Half-width-kana[半角ｶﾅ;HANKAKU KANA] -> normal Katakana`
`9`	`9`	`- Wide-alphanumeric[全角英数;ZENKAKU EISU] <-> normal ASCII`
`10`	`10`
`11`		`-If you need canonicalization oftext including Japanese, consider to use[unicode_normalization](https://github.com/unicode-rs/unicode-normalization) crate at first.`
	`11`	`+If you need canonicalization oftexts including Japanese, consider to use[unicode_normalization](https://github.com/unicode-rs/unicode-normalization) crate at first.`
`12`	`12`	`NFD, NFKD, NFC and NFKC can be used.`
`13`	`13`	`This crate, however, works with you if you are in a niche such as a need of delicate control of Japanese characters for a restrictive character terminal.`
`14`	`14`

Lines changed: 22 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,29 @@`
`1`	`1`
`2`	`2`	`//! Converters of troublesome characters included in Japanese texts.`
`3`	`3`	`//!`
`4`		`-//! Half-width-kana[半角ｶﾅ;HANKAKU KANA] -> normal Katakana`
	`4`	`+//! * Half-width-kana[半角ｶﾅ;HANKAKU KANA] -> normal Katakana`
	`5`	`+//! * Wide-alphanumeric[全角英数;ZENKAKU EISU] <-> normal ASCII`
`5`	`6`	`//!`
`6`		`-//! Wide-alphanumeric[全角英数;ZENKAKU EISU] <-> normal ASCII`
`7`		`-`
	`7`	`+//! # Example`
	`8`	+//! ```
	`9`	`+//! extern crate kana;`
	`10`	`+//! use kana::Kana;`
	`11`	`+//!`
	`12`	`+//! fn main() {`
	`13`	`+//! let k = Kana::init();`
	`14`	`+//!`
	`15`	`+//! let s1 = "ﾏﾂｵﾊﾞｼｮｳｱﾟ";`
	`16`	`+//! assert_eq!("マツオバショウア゚", k.half2kana(s1));`
	`17`	`+//! assert_eq!("マツオバショウア゚", k.half2full(s1));`
	`18`	`+//!`
	`19`	`+//! let s2 = "ひ゜ひ゛んは゛";`
	`20`	`+//! assert_eq!("ぴびんば", k.combine(s2));`
	`21`	`+//! assert_eq!("ぴびんば", kana::vsmark2combi(s2));`
	`22`	`+//!`
	`23`	`+//! let s3 = "＃＆Ｒｕｓｔ－１．６！";`
	`24`	`+//! assert_eq!("#&Rust-1.6!", kana::wide2ascii(s3));`
	`25`	`+//! }`
	`26`	+//! ```
`8`	`27`
`9`	`28`	`#[macro_use]externcrate maplit;`
`10`	`29`	`#[macro_use]externcrate lazy_static;`

Comments

(0)