Skip to content

Commit

Permalink
Switch order of Usage and Description to make it UNIX standard (#1093)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
LostInCompilation authored Nov 25, 2024
1 parent 3539bd1 commit 3306c44
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions include/CLI/impl/Formatter_inl.hpp
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

0 comments on commit 3306c44

Please sign in to comment.