From 8d7b52d5ef6d6150c95addeb0ca550f4f9a9ecbb Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Sun, 5 Oct 2025 10:26:18 -0400 Subject: [PATCH] Use less verbose "detailed" instead of "includeLongDescription" --- SabreTools.CommandLine/CommandSet.cs | 10 +++--- .../Features/HelpExtended.cs | 2 +- SabreTools.CommandLine/Inputs/UserInput.cs | 32 +++++++++---------- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/SabreTools.CommandLine/CommandSet.cs b/SabreTools.CommandLine/CommandSet.cs index 213ac02..1477f19 100644 --- a/SabreTools.CommandLine/CommandSet.cs +++ b/SabreTools.CommandLine/CommandSet.cs @@ -184,7 +184,7 @@ namespace SabreTools.CommandLine output.Add("Available options:"); foreach (var input in _inputs.Values) { - var outputs = input.FormatRecursive(pre: 2, midpoint: 30, includeLongDescription: true); + var outputs = input.FormatRecursive(pre: 2, midpoint: 30, detailed: true); if (outputs != null) output.AddRange(outputs); } @@ -201,8 +201,8 @@ namespace SabreTools.CommandLine /// Output a single feature recursively /// /// Name of the feature to output information for, if possible - /// True if the long description should be formatted and output, false otherwise - public void OutputFeatureHelp(string? featureName, bool includeLongDescription = false) + /// True if the long description should be formatted and output, false otherwise + public void OutputFeatureHelp(string? featureName, bool detailed = false) { // If the feature name is null, empty, or just consisting of leading characters string trimmedName = featureName?.TrimStart('-', '/', '\\') ?? string.Empty; @@ -222,7 +222,7 @@ namespace SabreTools.CommandLine // Append the formatted text List output = []; output.Add($"Available options for {featureName}:"); - output.AddRange(input.FormatRecursive(pre: 2, midpoint: 30, includeLongDescription)); + output.AddRange(input.FormatRecursive(pre: 2, midpoint: 30, detailed)); // Now write out everything in a staged manner WriteOutWithPauses(output); @@ -243,7 +243,7 @@ namespace SabreTools.CommandLine output.Add($"\"{featureName}\" not found. Did you mean:"); foreach (string possible in startsWith) { - output.AddRange(_inputs[possible].Format(pre: 2, midpoint: 30, includeLongDescription)); + output.AddRange(_inputs[possible].Format(pre: 2, midpoint: 30, detailed)); } // Now write out everything in a staged manner diff --git a/SabreTools.CommandLine/Features/HelpExtended.cs b/SabreTools.CommandLine/Features/HelpExtended.cs index 7d838d9..dbecef4 100644 --- a/SabreTools.CommandLine/Features/HelpExtended.cs +++ b/SabreTools.CommandLine/Features/HelpExtended.cs @@ -36,7 +36,7 @@ // If we had something else after help if (args.Length > 1) { - parentSet?.OutputFeatureHelp(args[1], includeLongDescription: true); + parentSet?.OutputFeatureHelp(args[1], detailed: true); return true; } diff --git a/SabreTools.CommandLine/Inputs/UserInput.cs b/SabreTools.CommandLine/Inputs/UserInput.cs index 5f9eda0..52b1541 100644 --- a/SabreTools.CommandLine/Inputs/UserInput.cs +++ b/SabreTools.CommandLine/Inputs/UserInput.cs @@ -615,19 +615,19 @@ namespace SabreTools.CommandLine.Inputs /// /// Create formatted help text /// - /// True if the long description should be formatted and output, false otherwise + /// True if the long description should be formatted and output, false otherwise /// Help text formatted as a list of strings - public List Format(bool includeLongDescription = false) - => Format(pre: 0, midpoint: 0, includeLongDescription); + public List Format(bool detailed = false) + => Format(pre: 0, midpoint: 0, detailed); /// /// Create formatted help text /// /// Positive number representing number of spaces to put in front of the feature /// Positive number representing the column where the description should start - /// True if the long description should be formatted and output, false otherwise + /// True if the long description should be formatted and output, false otherwise /// Help text formatted as a list of strings - public List Format(int pre, int midpoint, bool includeLongDescription = false) + public List Format(int pre, int midpoint, bool detailed = false) { // Create the output list List outputList = []; @@ -636,7 +636,7 @@ namespace SabreTools.CommandLine.Inputs outputList.Add(FormatStandard(pre, midpoint)); // Add the long description, if needed - if (includeLongDescription) + if (detailed) outputList.AddRange(FormatLongDescription(pre, midpoint)); return outputList; @@ -645,20 +645,20 @@ namespace SabreTools.CommandLine.Inputs /// /// Create formatted help text including all children /// - /// True if the long description should be formatted and output, false otherwise + /// True if the long description should be formatted and output, false otherwise /// Help text formatted as a list of strings - public List FormatRecursive(bool includeLongDescription = false) - => FormatRecursive(tabLevel: 0, pre: 0, midpoint: 0, includeLongDescription); + public List FormatRecursive(bool detailed = false) + => FormatRecursive(tabLevel: 0, pre: 0, midpoint: 0, detailed); /// /// Create formatted help text including all children /// /// Positive number representing number of spaces to put in front of the feature /// Positive number representing the column where the description should start - /// True if the long description should be formatted and output, false otherwise + /// True if the long description should be formatted and output, false otherwise /// Help text formatted as a list of strings - public List FormatRecursive(int pre, int midpoint, bool includeLongDescription = false) - => FormatRecursive(tabLevel: 0, pre, midpoint, includeLongDescription); + public List FormatRecursive(int pre, int midpoint, bool detailed = false) + => FormatRecursive(tabLevel: 0, pre, midpoint, detailed); /// /// Pre-format the flags for output @@ -785,9 +785,9 @@ namespace SabreTools.CommandLine.Inputs /// Level of indentation for this feature /// Positive number representing number of spaces to put in front of the feature /// Positive number representing the column where the description should start - /// True if the long description should be formatted and output, false otherwise + /// True if the long description should be formatted and output, false otherwise /// Help text formatted as a list of strings - private List FormatRecursive(int tabLevel, int pre = 0, int midpoint = 0, bool includeLongDescription = false) + private List FormatRecursive(int tabLevel, int pre = 0, int midpoint = 0, bool detailed = false) { // Create the output list List outputList = []; @@ -805,13 +805,13 @@ namespace SabreTools.CommandLine.Inputs outputList.Add(FormatStandard(preAdjusted, midpointAdjusted)); // Add the long description, if needed - if (includeLongDescription) + if (detailed) outputList.AddRange(FormatLongDescription(preAdjusted, midpointAdjusted)); // Append all children recursively foreach (var feature in Children.Values) { - outputList.AddRange(feature.FormatRecursive(tabLevel + 1, pre, midpoint, includeLongDescription)); + outputList.AddRange(feature.FormatRecursive(tabLevel + 1, pre, midpoint, detailed)); } return outputList;