Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-15 23:32:32 +00:00
Code Issues Projects Releases Packages Wiki Activity

clippy doc_markdown

Browse source
This commit is contained in:
Corentin Henry 2017-06-08 11:42:10 -07:00
parent be6ce71d33
commit 2f0e511ab6
3 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/app/help.rs
View file

@ -726,9 +726,9 @@ fn copy_until<R: Read, W: Write>(r: &mut R, w: &mut W, delimiter_byte: u8) -> Co
/// Copies the contents of a reader into a writer until a {tag} is found, /// Copies the contents of a reader into a writer until a {tag} is found,
/// copying the tag content to a buffer and returning its size. /// copying the tag content to a buffer and returning its size.
/// In addition to errors, there are three possible outputs: /// In addition to errors, there are three possible outputs:
/// - None: The reader was consumed. /// - `None`: The reader was consumed.
/// - Some(Ok(0)): No tag was captured but the reader still contains data. /// - `Some(Ok(0))`: No tag was captured but the reader still contains data.
/// - Some(Ok(length>0)): a tag with `length` was captured to the tag_buffer. /// - `Some(Ok(length>0))`: a tag with `length` was captured to the `tag_buffer`.
fn copy_and_capture<R: Read, W: Write>(r: &mut R, fn copy_and_capture<R: Read, W: Write>(r: &mut R,
w: &mut W, w: &mut W,
tag_buffer: &mut Cursor<Vec<u8>>) tag_buffer: &mut Cursor<Vec<u8>>)

8
src/lib.rs
View file

@ -327,9 +327,9 @@
//! //!
//! #### Features enabled by default //! #### Features enabled by default
//! //!
//! * **"suggestions"**: Turns on the `Did you mean '--myoption'?` feature for when users make typos. (builds dependency `strsim`) //! * `suggestions`: Turns on the `Did you mean '--myoption'?` feature for when users make typos. (builds dependency `strsim`)
//! * **"color"**: Turns on colored error messages. This feature only works on non-Windows OSs. (builds dependency `ansi-term` and `atty`) //! * `color`: Turns on colored error messages. This feature only works on non-Windows OSs. (builds dependency `ansi-term` and `atty`)
//! * **"wrap_help"**: Wraps the help at the actual terminal width when available, instead of 120 chracters. (builds dependency `term_size`) //! * `wrap_help`: Wraps the help at the actual terminal width when available, instead of 120 chracters. (builds dependency `term_size`)
//! //!
//! To disable these, add this to your `Cargo.toml`: //! To disable these, add this to your `Cargo.toml`:
//! //!
@ -478,7 +478,7 @@
//! //!
//! ### Compatibility Policy //! ### Compatibility Policy
//! //!
//! Because `clap` takes SemVer and compatibility seriously, this is the official policy regarding //! Because `clap` takes `SemVer` and compatibility seriously, this is the official policy regarding
//! breaking changes and previous versions of Rust. //! breaking changes and previous versions of Rust.
//! //!
//! `clap` will pin the minimum required version of Rust to the CI builds. Bumping the minimum //! `clap` will pin the minimum required version of Rust to the CI builds. Bumping the minimum

2
src/macros.rs
View file

@ -371,7 +371,7 @@ macro_rules! arg_enum {
} }
/// Allows you to pull the version from your Cargo.toml at compile time as /// Allows you to pull the version from your Cargo.toml at compile time as
/// MAJOR.MINOR.PATCH_PKGVERSION_PRE /// `MAJOR.MINOR.PATCH_PKGVERSION_PRE`
/// ///
/// # Examples /// # Examples
/// ///