diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testColorDoccReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testColorDoccReference().md index ccdb71eb2..77ea1653a 100644 --- a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testColorDoccReference().md +++ b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testColorDoccReference().md @@ -6,19 +6,19 @@ color --fav= [--second=] [--help] ``` -- term **--fav=\:** +- term **--fav=\**: *Your favorite color.* -- term **--second=\:** +- term **--second=\**: *Your second favorite color.* This is optional. -- term **--help:** +- term **--help**: *Show help information.* @@ -31,7 +31,7 @@ Show subcommand help information. color help [...] ``` -- term **subcommands:** +- term **subcommands**: diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testCountLinesDoccReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testCountLinesDoccReference().md index ca99aa54b..77b80fe5c 100644 --- a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testCountLinesDoccReference().md +++ b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testCountLinesDoccReference().md @@ -6,22 +6,22 @@ count-lines [] [--prefix=] [--verbose] [--help] ``` -- term **input-file:** +- term **input-file**: *A file to count lines in. If omitted, counts the lines of stdin.* -- term **--prefix=\:** +- term **--prefix=\**: *Only count lines with this prefix.* -- term **--verbose:** +- term **--verbose**: *Include extra information in the output.* -- term **--help:** +- term **--help**: *Show help information.* @@ -34,7 +34,7 @@ Show subcommand help information. count-lines help [...] ``` -- term **subcommands:** +- term **subcommands**: diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testMathDoccReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testMathDoccReference().md index f91c7643b..3088879f0 100644 --- a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testMathDoccReference().md +++ b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testMathDoccReference().md @@ -8,12 +8,12 @@ A utility for performing maths. math [--version] [--help] ``` -- term **--version:** +- term **--version**: *Show the version.* -- term **--help:** +- term **--help**: *Show help information.* @@ -26,22 +26,22 @@ Print the sum of the values. math add [--hex-output] [...] [--version] [--help] ``` -- term **--hex-output:** +- term **--hex-output**: *Use hexadecimal notation for the result.* -- term **values:** +- term **values**: *A group of integers to operate on.* -- term **--version:** +- term **--version**: *Show the version.* -- term **--help:** +- term **--help**: *Show help information.* @@ -56,22 +56,22 @@ Print the product of the values. math multiply [--hex-output] [...] [--version] [--help] ``` -- term **--hex-output:** +- term **--hex-output**: *Use hexadecimal notation for the result.* -- term **values:** +- term **values**: *A group of integers to operate on.* -- term **--version:** +- term **--version**: *Show the version.* -- term **--help:** +- term **--help**: *Show help information.* @@ -86,12 +86,12 @@ Calculate descriptive statistics. math stats [--version] [--help] ``` -- term **--version:** +- term **--version**: *Show the version.* -- term **--help:** +- term **--help**: *Show help information.* @@ -104,22 +104,22 @@ Print the average of the values. math stats average [--kind=] [...] [--version] [--help] ``` -- term **--kind=\:** +- term **--kind=\**: *The kind of average to provide.* -- term **values:** +- term **values**: *A group of floating-point values to operate on.* -- term **--version:** +- term **--version**: *Show the version.* -- term **--help:** +- term **--help**: *Show help information.* @@ -134,17 +134,17 @@ Print the standard deviation of the values. math stats stdev [...] [--version] [--help] ``` -- term **values:** +- term **values**: *A group of floating-point values to operate on.* -- term **--version:** +- term **--version**: *Show the version.* -- term **--help:** +- term **--help**: *Show help information.* @@ -159,41 +159,41 @@ Print the quantiles of the values (TBD). math stats quantiles [] [] [] [...] [--file=] [--directory=] [--shell=] [--custom=] [--custom-deprecated=] [--version] [--help] ``` -- term **one-of-four:** +- term **one-of-four**: -- term **custom-arg:** +- term **custom-arg**: -- term **custom-deprecated-arg:** +- term **custom-deprecated-arg**: -- term **values:** +- term **values**: *A group of floating-point values to operate on.* -- term **--file=\:** +- term **--file=\**: -- term **--directory=\:** +- term **--directory=\**: -- term **--shell=\:** +- term **--shell=\**: -- term **--custom=\:** +- term **--custom=\**: -- term **--custom-deprecated=\:** +- term **--custom-deprecated=\**: -- term **--version:** +- term **--version**: *Show the version.* -- term **--help:** +- term **--help**: *Show help information.* @@ -210,7 +210,7 @@ Show subcommand help information. math help [...] ``` -- term **subcommands:** +- term **subcommands**: diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRepeatDoccReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRepeatDoccReference().md index a7ec2089d..9e6e982dc 100644 --- a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRepeatDoccReference().md +++ b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRepeatDoccReference().md @@ -6,22 +6,22 @@ repeat [--count=] [--include-counter] [--help] ``` -- term **--count=\:** +- term **--count=\**: *The number of times to repeat 'phrase'.* -- term **--include-counter:** +- term **--include-counter**: *Include a counter with each repetition.* -- term **phrase:** +- term **phrase**: *The phrase to repeat.* -- term **--help:** +- term **--help**: *Show help information.* @@ -34,7 +34,7 @@ Show subcommand help information. repeat help [...] ``` -- term **subcommands:** +- term **subcommands**: diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRollDoccReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRollDoccReference().md index 03a66a718..5db09afbb 100644 --- a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRollDoccReference().md +++ b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRollDoccReference().md @@ -6,29 +6,29 @@ roll [--times=] [--sides=] [--seed=] [--verbose] [--help] ``` -- term **--times=\:** +- term **--times=\**: *Rolls the dice times.* -- term **--sides=\:** +- term **--sides=\**: *Rolls an -sided dice.* Use this option to override the default value of a six-sided die. -- term **--seed=\:** +- term **--seed=\**: *A seed to use for repeatable random generation.* -- term **--verbose:** +- term **--verbose**: *Show all roll results.* -- term **--help:** +- term **--help**: *Show help information.* @@ -41,7 +41,7 @@ Show subcommand help information. roll help [...] ``` -- term **subcommands:** +- term **subcommands**: diff --git a/Tools/generate-docc-reference/Extensions/ArgumentParser+Markdown.swift b/Tools/generate-docc-reference/Extensions/ArgumentParser+Markdown.swift index 6ec7850aa..5e8f57876 100644 --- a/Tools/generate-docc-reference/Extensions/ArgumentParser+Markdown.swift +++ b/Tools/generate-docc-reference/Extensions/ArgumentParser+Markdown.swift @@ -74,7 +74,7 @@ extension CommandInfoV0 { switch markdownStyle { case .docc: - result += "- term **\(arg.identity()):**\n\n" + result += "- term **\(arg.identity())**:\n\n" case .github: result += "**\(arg.identity()):**\n\n" }