fix: handle the assignment of the default sectionTitle value in the generate-docc command instead of in toolinfo

Author: Chamepp

Sources/ArgumentParserToolInfo/ToolInfo.swift

@@ -218,23 +218,7 @@ public struct ArgumentInfoV0: Codable, Hashable {
     self.kind = kind
 
     self.shouldDisplay = shouldDisplay
-
-    // The section title helps categorize arguments
-    // for better organization in documentation.
-
-    // The switch statement checks the kind of argument
-    // and assigns a default section title related to the argument type
-    // if the provided one is nil.
-    switch kind {
-    case .positional:
-      self.sectionTitle = sectionTitle ?? "Arguments"
-
-    case .option:
-      self.sectionTitle = sectionTitle ?? "Optionals"
-
-    case .flag:
-      self.sectionTitle = sectionTitle ?? "Flags"
-    }
+    self.sectionTitle = sectionTitle
 
     self.isOptional = isOptional
     self.isRepeating = isRepeating

Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testColorDoccReference().md

@@ -13,7 +13,7 @@ color --fav=<fav> [--second=<second>] [--help]
 *Show help information.*
 
 
-## Optionals
+## Options
 
 **`--fav=\<fav\>`**
 
@@ -37,6 +37,6 @@ Show subcommand help information.
 color help [<subcommands>...] 
 ```
 
-## Arguments
+## General
 
 **`subcommands`**

Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testCountLinesDoccReference().md

@@ -25,7 +25,7 @@ count-lines [<input-file>] [--prefix=<prefix>] [--verbose] [--help]
 *Show help information.*
 
 
-## Optionals
+## Options
 
 **`--prefix=\<prefix\>`**
 
@@ -42,6 +42,6 @@ Show subcommand help information.
 count-lines help [<subcommands>...] 
 ```
 
-## Arguments
+## General
 
 **`subcommands`**

Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testMathDoccReference().md

@@ -30,18 +30,16 @@ Print the sum of the values.
 math add [--hex-output] [<values>...] [--version] [--help]
 ```
 
-## Arguments
+## General
 
-**`values`**
-
-*A group of integers to operate on.*
+**`--hex-output`**
 
+*Use hexadecimal notation for the result.*
 
-## Flags
 
-**`--hex-output`**
+**`values`**
 
-*Use hexadecimal notation for the result.*
+*A group of integers to operate on.*
 
 
 **`--version`**
@@ -59,18 +57,16 @@ Print the product of the values.
 math multiply [--hex-output] [<values>...] [--version] [--help]
 ```
 
-## Arguments
+## General
 
-**`values`**
-
-*A group of integers to operate on.*
+**`--hex-output`**
 
+*Use hexadecimal notation for the result.*
 
-## Flags
 
-**`--hex-output`**
+**`values`**
 
-*Use hexadecimal notation for the result.*
+*A group of integers to operate on.*
 
 
 **`--version`**
@@ -88,7 +84,7 @@ Calculate descriptive statistics.
 math stats [--version] [--help]
 ```
 
-## Flags
+## General
 
 **`--version`**
 
@@ -110,46 +106,40 @@ Print the average of the values.
 math stats average [--kind=<kind>] [<values>...] [--version] [--help]
 ```
 
-## Arguments
+## General
+
+**`--kind=\<kind\>`**
+
+*The kind of average to provide.*
+
 
 **`values`**
 
 *A group of floating-point values to operate on.*
 
 
-## Flags
-
 **`--version`**
 
 *Show the version.*
 
 
 **`--help`**
 
-*Show help information.*
-
-
-## Optionals
-
-**`--kind=\<kind\>`**
-
-*The kind of average to provide.*### math.stats.stdev
+*Show help information.*### math.stats.stdev
 
 Print the standard deviation of the values.
 
 ```
 math stats stdev [<values>...] [--version] [--help]
 ```
 
-## Arguments
+## General
 
 **`values`**
 
 *A group of floating-point values to operate on.*
 
 
-## Flags
-
 **`--version`**
 
 *Show the version.*
@@ -165,7 +155,7 @@ Print the quantiles of the values (TBD).
 math stats quantiles [<one-of-four>] [<custom-arg>] [<values>...]     [--file=<file>] [--directory=<directory>] [--shell=<shell>] [--custom=<custom>] [--version] [--help]
 ```
 
-## Arguments
+## General
 
 **`one-of-four`**
 
@@ -178,37 +168,33 @@ math stats quantiles [<one-of-four>] [<custom-arg>] [<values>...]     [--file=<f
 *A group of floating-point values to operate on.*
 
 
-## Flags
-
-**`--version`**
-
-*Show the version.*
+**`--file=\<file\>`**
 
 
-**`--help`**
+**`--directory=\<directory\>`**
 
-*Show help information.*
 
+**`--shell=\<shell\>`**
 
-## Optionals
 
-**`--file=\<file\>`**
+**`--custom=\<custom\>`**
 
 
-**`--directory=\<directory\>`**
+**`--version`**
 
+*Show the version.*
 
-**`--shell=\<shell\>`**
 
+**`--help`**
 
-**`--custom=\<custom\>`**## math.help
+*Show help information.*## math.help
 
 Show subcommand help information.
 
 ```
 math help [<subcommands>...] 
 ```
 
-## Arguments
+## General
 
 **`subcommands`**

Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRepeatDoccReference().md

@@ -25,7 +25,7 @@ repeat [--count=<count>] [--include-counter] <phrase> [--help]
 *Show help information.*
 
 
-## Optionals
+## Options
 
 **`--count=\<count\>`**
 
@@ -42,6 +42,6 @@ Show subcommand help information.
 repeat help [<subcommands>...] 
 ```
 
-## Arguments
+## General
 
 **`subcommands`**

Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRollDoccReference().md

@@ -18,7 +18,7 @@ roll [--times=<n>] [--sides=<m>] [--seed=<seed>] [--verbose] [--help]
 *Show help information.*
 
 
-## Optionals
+## Options
 
 **`--times=\<n\>`**
 
@@ -47,6 +47,6 @@ Show subcommand help information.
 roll help [<subcommands>...] 
 ```
 
-## Arguments
+## General
 
 **`subcommands`**

Tests/ArgumentParserUnitTests/Snapshots/testADumpHelp().json

@@ -29,7 +29,6 @@
           "kind" : "long",
           "name" : "enumerated-option"
         },
-        "sectionTitle" : "Optionals",
         "shouldDisplay" : true,
         "valueName" : "enumerated-option"
       },
@@ -62,7 +61,6 @@
           "kind" : "long",
           "name" : "enumerated-option-with-default-value"
         },
-        "sectionTitle" : "Optionals",
         "shouldDisplay" : true,
         "valueName" : "enumerated-option-with-default-value"
       },
@@ -80,7 +78,6 @@
           "kind" : "long",
           "name" : "no-help-option"
         },
-        "sectionTitle" : "Optionals",
         "shouldDisplay" : true,
         "valueName" : "no-help-option"
       },
@@ -99,7 +96,6 @@
           "kind" : "long",
           "name" : "int-option"
         },
-        "sectionTitle" : "Optionals",
         "shouldDisplay" : true,
         "valueName" : "int-option"
       },
@@ -119,15 +115,13 @@
           "kind" : "long",
           "name" : "int-option-with-default-value"
         },
-        "sectionTitle" : "Optionals",
         "shouldDisplay" : true,
         "valueName" : "int-option-with-default-value"
       },
       {
         "isOptional" : false,
         "isRepeating" : false,
         "kind" : "positional",
-        "sectionTitle" : "Arguments",
         "shouldDisplay" : true,
         "valueName" : "arg"
       },
@@ -136,7 +130,6 @@
         "isOptional" : false,
         "isRepeating" : false,
         "kind" : "positional",
-        "sectionTitle" : "Arguments",
         "shouldDisplay" : true,
         "valueName" : "arg-with-help"
       },
@@ -146,7 +139,6 @@
         "isOptional" : true,
         "isRepeating" : false,
         "kind" : "positional",
-        "sectionTitle" : "Arguments",
         "shouldDisplay" : true,
         "valueName" : "arg-with-default-value"
       },
@@ -169,7 +161,6 @@
           "kind" : "long",
           "name" : "help"
         },
-        "sectionTitle" : "Flags",
         "shouldDisplay" : true,
         "valueName" : "help"
       }
@@ -184,7 +175,6 @@
             "isOptional" : true,
             "isRepeating" : true,
             "kind" : "positional",
-            "sectionTitle" : "Arguments",
             "shouldDisplay" : true,
             "valueName" : "subcommands"
           },
@@ -210,7 +200,6 @@
               "kind" : "long",
               "name" : "help"
             },
-            "sectionTitle" : "Flags",
             "shouldDisplay" : false,
             "valueName" : "help"
           }

Tests/ArgumentParserUnitTests/Snapshots/testBDumpHelp().json

@@ -56,7 +56,6 @@
           "kind" : "long",
           "name" : "help"
         },
-        "sectionTitle" : "Flags",
         "shouldDisplay" : true,
         "valueName" : "help"
       }
@@ -71,7 +70,6 @@
             "isOptional" : true,
             "isRepeating" : true,
             "kind" : "positional",
-            "sectionTitle" : "Arguments",
             "shouldDisplay" : true,
             "valueName" : "subcommands"
           },
@@ -97,7 +95,6 @@
               "kind" : "long",
               "name" : "help"
             },
-            "sectionTitle" : "Flags",
             "shouldDisplay" : false,
             "valueName" : "help"
           }