Skip to content
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

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

Merged
merged 1 commit into from
Nov 25, 2024
Merged

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

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
6 changes: 3 additions & 3 deletions include/CLI/impl/Formatter_inl.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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);
Expand Down
Loading