1
0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-04-29 12:13:52 +00:00

Switch order of Usage and Description to make it UNIX standard (#1093)

When I rewrote the Help formatter (see #866) I mixed up the order of the
Usage and Description strings. I flipped the order to make it UNIX style
again.
All tests pass.
This commit is contained in:
Marc 2024-11-25 14:21:01 +01:00 committed by GitHub
parent 3539bd185f
commit 3306c444f2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -89,7 +89,7 @@ CLI11_INLINE std::string Formatter::make_description(const App *app) const {
desc += " \n[At most " + std::to_string(max_options) + " of the following options are allowed]";
}
return (!desc.empty()) ? desc + "\n" : std::string{};
return (!desc.empty()) ? desc + "\n\n" : std::string{};
}
CLI11_INLINE std::string Formatter::make_usage(const App *app, std::string name) const {
@ -164,9 +164,9 @@ CLI11_INLINE std::string Formatter::make_help(const App *app, std::string name,
}
}
out << make_usage(app, name);
detail::streamOutAsParagraph(
out, make_description(app), description_paragraph_width_, " "); // Format description as paragraph
out, make_description(app), description_paragraph_width_, ""); // Format description as paragraph
out << make_usage(app, name);
out << make_positionals(app);
out << make_groups(app, mode);
out << make_subcommands(app, mode);