Skip to content

Commit

Permalink
s/Man/Manual/
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshuawuyts committed Aug 3, 2018
1 parent c49bd80 commit a8ba1a7
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ extern crate man;
use man::prelude::*;

fn main() {
let page = Man::new("basic")
.description("A basic example")
let page = Manual::new("basic")
.about("A basic example")
.author(Author::new("Alice Person").email("alice@person.com"))
.author(Author::new("Bob Human").email("bob@human.com"))
.flag(Flag::new().short("-d").long("--deubg").description("Enable debug mode"))
Expand Down
2 changes: 1 addition & 1 deletion examples/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ extern crate man;
use man::prelude::*;

fn main() {
let msg = Man::new("auth-service")
let msg = Manual::new("auth-service")
.about("authorize & authenticate members".into())
.arg(Arg::new("path"))
.env(Env::new("PORT").help("The network port to listen to"))
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ pub use arg::Arg;
pub use author::Author;
pub use environment::Env;
pub use flag::Flag;
pub use man::Man;
pub use man::Manual;
pub use option::Opt;
4 changes: 2 additions & 2 deletions src/man.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use roff::{bold, italic, list, Roff, Troffable};

/// Man page struct.
#[derive(Debug, Clone)]
pub struct Man {
pub struct Manual {
name: String,
about: Option<String>,
authors: Vec<Author>,
Expand All @@ -13,7 +13,7 @@ pub struct Man {
arguments: Vec<Arg>,
}

impl Man {
impl Manual {
/// Create a new instance.
pub fn new(name: &str) -> Self {
Self {
Expand Down
2 changes: 1 addition & 1 deletion src/prelude.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ pub use arg::Arg;
pub use author::Author;
pub use environment::Env;
pub use flag::Flag;
pub use man::Man;
pub use man::Manual;
pub use option::Opt;

0 comments on commit a8ba1a7

Please sign in to comment.