From d52501834ad35336c8c9e3c9f9805417146d190e Mon Sep 17 00:00:00 2001 From: Robert Bastian Date: Sat, 18 Feb 2023 00:50:35 +0100 Subject: [PATCH] docs.rs --- provider/datagen/README.md | 36 ----------------------------- provider/datagen/src/bin/datagen.rs | 9 +------- provider/datagen/src/lib.rs | 4 +++- 3 files changed, 4 insertions(+), 45 deletions(-) diff --git a/provider/datagen/README.md b/provider/datagen/README.md index a3994bf32e0..6b62e9d3fd8 100644 --- a/provider/datagen/README.md +++ b/provider/datagen/README.md @@ -5,43 +5,7 @@ Data files can be generated either programmatically (i.e. in `build.rs`), or through a command-line utility. -## Examples -### `build.rs` - -```rust -use icu_datagen::prelude::*; -use std::fs::File; - -fn main() { - icu_datagen::datagen( - Some(&[langid!("de"), langid!("en-AU")]), - &[icu::list::provider::AndListV1Marker::KEY], - &SourceData::default(), - vec![Out::Blob(Box::new(File::create("data.postcard").unwrap()))], - ) - .unwrap(); -} -``` - -### Command line - -The command line interface can be installed with the `bin` Cargo feature. - -```bash -$ cargo install icu4x-datagen -``` - -Once the tool is installed, you can invoke it like this: - -```bash -$ icu4x-datagen \ -> --keys all \ -> --locales de en-AU \ -> --format blob \ -> --out data.postcard -``` -More details can be found by running `--help`. ## More Information diff --git a/provider/datagen/src/bin/datagen.rs b/provider/datagen/src/bin/datagen.rs index b8a6edd2857..63e802b9b8a 100644 --- a/provider/datagen/src/bin/datagen.rs +++ b/provider/datagen/src/bin/datagen.rs @@ -12,14 +12,7 @@ fn main() -> eyre::Result<()> { let matches = App::new("icu4x-datagen") .version(crate_version!()) .author(crate_authors!()) - .about(concat!( - "Learn more at: https://github.com/unicode-org/icu4x/blob/icu%40", - std::env!("CARGO_PKG_VERSION_MAJOR"), - ".", - std::env!("CARGO_PKG_VERSION_MINOR"), - ".0", // we don't tag patch releases - "/docs/tutorials/data_management.md" - )) + .about(concat!("Learn more at: https://docs.rs/icu_datagen/", crate_version!())) .arg( Arg::with_name("VERBOSE") .short("v") diff --git a/provider/datagen/src/lib.rs b/provider/datagen/src/lib.rs index e08d8d8b62c..a363e5e7acd 100644 --- a/provider/datagen/src/lib.rs +++ b/provider/datagen/src/lib.rs @@ -7,6 +7,9 @@ //! //! Data files can be generated either programmatically (i.e. in `build.rs`), or through a //! command-line utility. +//! +//! +#![doc = concat!("Also see our [datagen tutorial](https://github.com/unicode-org/icu4x/blob/icu%40", std::env!("CARGO_PKG_VERSION_MAJOR"), ".", std::env!("CARGO_PKG_VERSION_MINOR"), ".0/docs/tutorials/data_management.md)")] //! //! # Examples //! @@ -44,7 +47,6 @@ //! > --format blob \ //! > --out data.postcard //! ``` - //! More details can be found by running `--help`. #![cfg_attr(