Move Positional Arguments into its own section in generated manpages #3580

ducaale · 2022-03-26T17:19:03Z

This PR also:

Adds Man::render_positionals_section() for rendering docs for positional arguments
Renders a header for each positional argument
Attempts to use Arg::value_name before falling back to Arg::id for the header names

Resolves #3579

epage · 2022-03-26T17:29:45Z

Attempts to use Arg::value_name before falling back to Arg::id for the header names

Could you split this out into its own PR?

clap_mangen/src/lib.rs

epage · 2022-03-26T17:30:31Z

clap_mangen/src/lib.rs

+    /// Render the POSITIONAL ARGUMENTS section into the writer.
+    pub fn render_positionals_section(&self, w: &mut dyn Write) -> Result<(), std::io::Error> {


I think more discussion is needed on #3579 before we merge this

move positional args out of the options section

0541a9a

epage reviewed Mar 26, 2022

View reviewed changes

clap_mangen/src/lib.rs Outdated Show resolved Hide resolved

epage reviewed Mar 26, 2022

View reviewed changes

ducaale mentioned this pull request Mar 28, 2022

Use Arg::value_name() as header for positionals in clap_mangen #3587

Merged

ducaale closed this Jan 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move Positional Arguments into its own section in generated manpages #3580

Move Positional Arguments into its own section in generated manpages #3580

ducaale commented Mar 26, 2022 •

edited

Loading

epage commented Mar 26, 2022

epage Mar 26, 2022

		/// Render the POSITIONAL ARGUMENTS section into the writer.
		pub fn render_positionals_section(&self, w: &mut dyn Write) -> Result<(), std::io::Error> {

Move Positional Arguments into its own section in generated manpages #3580

Move Positional Arguments into its own section in generated manpages #3580

Conversation

ducaale commented Mar 26, 2022 • edited Loading

epage commented Mar 26, 2022

epage Mar 26, 2022

Choose a reason for hiding this comment

ducaale commented Mar 26, 2022 •

edited

Loading