summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMaxime Coste <mawww@kakoune.org>2017-06-04 08:37:51 +0100
committerMaxime Coste <mawww@kakoune.org>2017-06-04 08:37:51 +0100
commit261e0fabccad0e147592d41b38390bdef24dd69d (patch)
treefe5b548b044b20714934d4cff9434cfe2aa13b0f /src
parent610113860629f2297c1a09f2038fe47ce6a18b3a (diff)
Improve readability of command docstrings by changing formatting
Fixes #1378
Diffstat (limited to 'src')
-rw-r--r--src/command_manager.cc13
-rw-r--r--src/commands.cc2
-rw-r--r--src/parameters_parser.cc2
3 files changed, 5 insertions, 12 deletions
diff --git a/src/command_manager.cc b/src/command_manager.cc
index e2294b37..fa7a5044 100644
--- a/src/command_manager.cc
+++ b/src/command_manager.cc
@@ -538,26 +538,19 @@ Optional<CommandInfo> CommandManager::command_info(const Context& context, Strin
}
String helpstr = cmd->value.helper(context, params);
if (not helpstr.empty())
- {
- if (helpstr.back() != '\n')
- helpstr += '\n';
- res.info += helpstr;
- }
+ res.info += format("{}\n", helpstr);
}
String aliases;
for (auto& alias : context.aliases().aliases_for(cmd->key))
aliases += " " + alias;
if (not aliases.empty())
- res.info += "Aliases:" + aliases + "\n";
+ res.info += format("Aliases:{}\n", aliases);
auto& switches = cmd->value.param_desc.switches;
if (not switches.empty())
- {
- res.info += "Switches:\n";
- res.info += generate_switches_doc(switches);
- }
+ res.info += format("Switches:\n{}", indent(generate_switches_doc(switches)));
return res;
}
diff --git a/src/commands.cc b/src/commands.cc
index 2f4df4bc..e2314c66 100644
--- a/src/commands.cc
+++ b/src/commands.cc
@@ -1222,7 +1222,7 @@ static String option_doc_helper(const Context& context, CommandParameters params
if (not desc or desc->docstring().empty())
return "";
- return format("{}: {}", desc->name(), desc->docstring());
+ return format("{}:\n{}", desc->name(), indent(desc->docstring()));
}
static OptionManager& get_options(StringView scope, const Context& context, StringView option_name)
diff --git a/src/parameters_parser.cc b/src/parameters_parser.cc
index 9ca475f7..b37e13d3 100644
--- a/src/parameters_parser.cc
+++ b/src/parameters_parser.cc
@@ -9,7 +9,7 @@ String generate_switches_doc(const SwitchMap& switches)
{
String res;
for (auto& sw : switches)
- res += format(" -{} {}: {}\n", sw.key,
+ res += format("-{} {}: {}\n", sw.key,
sw.value.takes_arg ? "<arg>" : "",
sw.value.description);
return res;