Skip to content

better title and description fallbacks #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
schacon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

better title and description fallbacks #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,15 +148,27 @@ fn write_help_markdown(

let title = match options.title {
Some(ref title) => title.to_owned(),
None => format!("Command-Line Help for `{title_name}`"),
None => {
// Try to use the command's about text as the title
if let Some(about) = command.get_about() {
about.to_string()
} else {
format!("Command-Line Help for `{title_name}`")
}
},
};
writeln!(buffer, "# {title}\n",).unwrap();

writeln!(
buffer,
"This document contains the help content for the `{}` command-line program.\n",
title_name
).unwrap();
// Use the command's long_about or about text as the introduction, if available
if let Some(long_about) = command.get_long_about() {
writeln!(buffer, "{}\n", long_about).unwrap();
} else {
writeln!(
buffer,
"This document contains the help content for the `{}` command-line program.\n",
title_name
).unwrap();
}

//----------------------------------
// Write the table of contents
Expand Down