blob42/rusty-man
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentaion for tui viewer

Browse Source
This commit is contained in:
Robin Krahl 2020-10-09 11:04:24 +02:00
parent ce06129976
commit 65c3fd7639
No known key found for this signature in database
GPG Key ID: 8E9B0870524F69D8
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/args.rs
View File

@ -39,7 +39,7 @@ pub struct Args {
#[structopt(name = "source", short, long, number_of_values = 1)]
pub source_paths: Vec<String>,
/// The viewer for the rustdoc documentation (one of: plain, rich)
/// The viewer for the rustdoc documentation (one of: plain, rich, tui)
#[structopt(long, parse(try_from_str = viewer::get_viewer))]
#[serde(deserialize_with = "deserialize_viewer")]
pub viewer: Option<Box<dyn viewer::Viewer>>,
@ -91,8 +91,8 @@ pub struct Args {
pub struct ViewerArgs {
/// Disable syntax highlighting.
///
/// Per default, rusty-man tries to highlight Rust code snippets in its output if the rich text
/// viewer is selected. If this option is set, it renders the HTML representation instead.
/// Per default, rusty-man tries to highlight Rust code snippets in its output if the rich or
/// tui viewer is selected. If this option is set, it renders the HTML representation instead.
#[merge(strategy = merge::bool::overwrite_false)]
#[structopt(long)]
pub no_syntax_highlight: bool,
@ -116,7 +116,7 @@ pub struct ViewerArgs {
/// The maximum width of the text output
///
/// Unless the --width option is set, rusty-man sets the width of the text output based on the
/// width of the terminal with the maximum width set with this optioj.
/// width of the terminal with the maximum width set with this option.
#[structopt(long)]
pub max_width: Option<usize>,
}

5
src/main.rs
View File

@ -18,9 +18,10 @@
//! `index` module.
//!
//! If we found a documentation item, we use a viewer to open it – see the `viewer` module.
//! Currently, there are two viewer implementations: `plain` converts the documentaion to plain
//! Currently, there are three viewer implementations: `plain` converts the documentaion to plain
//! text, `rich` adds some formatting to it. Both viewers pipe their output through a pager, if
//! available.
//! available. The third viewer, `tui`, provides an interactive interface for browsing the
//! documentation.
//!
//! The documentation is scraped from the HTML files generated by `rustdoc`. See the `parser`
//! module for the scraping and the `doc::Doc` struct for the structure of the documentation items.