1
Fork 0
mirror of https://github.com/RGBCube/uutils-coreutils synced 2025-07-29 03:57:44 +00:00

Merge pull request #3160 from sylvestre/doc-order

user docs: move the examples after the options
This commit is contained in:
Terts Diepraam 2022-02-19 15:53:37 +01:00 committed by GitHub
commit c56a879a68
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -72,8 +72,8 @@ fn write_markdown(
write_version(&mut w, app)?; write_version(&mut w, app)?;
write_usage(&mut w, app, name)?; write_usage(&mut w, app, name)?;
write_description(&mut w, app)?; write_description(&mut w, app)?;
write_examples(&mut w, name, tldr_zip)?; write_options(&mut w, app)?;
write_options(&mut w, app) write_examples(&mut w, name, tldr_zip)
} }
fn write_version(w: &mut impl Write, app: &App) -> io::Result<()> { fn write_version(w: &mut impl Write, app: &App) -> io::Result<()> {
@ -201,7 +201,11 @@ fn write_options(w: &mut impl Write, app: &App) -> io::Result<()> {
write!(w, "</code>")?; write!(w, "</code>")?;
} }
writeln!(w, "</dt>")?; writeln!(w, "</dt>")?;
writeln!(w, "<dd>\n\n{}\n\n</dd>", arg.get_help().unwrap_or_default())?; writeln!(
w,
"<dd>\n\n{}\n\n</dd>",
arg.get_help().unwrap_or_default().replace("\n", "<br />")
)?;
} }
writeln!(w, "</dl>") writeln!(w, "</dl>\n")
} }