Switch the top level help item to be Description: rather than the name of the command which was inconsistent (#1335)

marcpopMSFT · web-flow · commit e3c8acadca50 · 2021-08-02T11:38:32.000-07:00
* Switch the top level help item to be Description: rather than the name of the command which was inconsistent

* Update Tile to Title to match the other ones.

* Fix the tests impacted by the new Description label
diff --git a/src/System.CommandLine.Tests/Help/Approvals/HelpBuilderTests.Help_describes_default_values_for_complex_root_command_scenario.approved.txt b/src/System.CommandLine.Tests/Help/Approvals/HelpBuilderTests.Help_describes_default_values_for_complex_root_command_scenario.approved.txt
@@ -1,4 +1,4 @@
-﻿the-root-command
+﻿Description:
   Test description
 
 Usage:
diff --git a/src/System.CommandLine.Tests/Help/HelpBuilderTests.cs b/src/System.CommandLine.Tests/Help/HelpBuilderTests.cs
@@ -57,7 +57,6 @@ public void Synopsis_section_keeps_added_newlines()
             _helpBuilder.Write(command);
 
             var expected =
-                $"{_executableName}{NewLine}" +
                 $"{_indentation}test{NewLine}" +
                 $"{_indentation}{NewLine}" +
                 $"{_indentation}description with{NewLine}" +
@@ -80,7 +79,6 @@ public void Synopsis_section_properly_wraps_description()
             helpBuilder.Write(command);
 
             var expected =
-                $@"{_executableName}{NewLine}" +
                 $"{_indentation}test\tdescription with some tabs that is long enough to wrap to a\t{NewLine}" +
                 $"{_indentation}new line{NewLine}{NewLine}";
 
diff --git a/src/System.CommandLine/Help/HelpBuilder.cs b/src/System.CommandLine/Help/HelpBuilder.cs
@@ -62,7 +62,7 @@ protected internal void Customize(ISymbol symbol,
 
         protected virtual void AddSynopsis(ICommand command)
         {
-            WriteHeading(command.Name, command.Description);
+            WriteHeading(Resources.Instance.HelpDescriptionTitle(), command.Description);
             Console.Out.WriteLine();
         }
 
diff --git a/src/System.CommandLine/Properties/Resources.Designer.cs b/src/System.CommandLine/Properties/Resources.Designer.cs
diff --git a/src/System.CommandLine/Properties/Resources.resx b/src/System.CommandLine/Properties/Resources.resx
@@ -185,6 +185,9 @@
   </data>
   <data name="HelpUsageTitle" xml:space="preserve">
     <value>Usage:</value>
+  </data>
+    <data name="HelpDescriptionTitle" xml:space="preserve">
+    <value>Description:</value>
   </data>
   <data name="HelpArgumentDefaultValueTitle" xml:space="preserve">
     <value>default</value>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.cs.xlf b/src/System.CommandLine/Properties/xlf/Resources.cs.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.de.xlf b/src/System.CommandLine/Properties/xlf/Resources.de.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.es.xlf b/src/System.CommandLine/Properties/xlf/Resources.es.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.fr.xlf b/src/System.CommandLine/Properties/xlf/Resources.fr.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.it.xlf b/src/System.CommandLine/Properties/xlf/Resources.it.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.ja.xlf b/src/System.CommandLine/Properties/xlf/Resources.ja.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.ko.xlf b/src/System.CommandLine/Properties/xlf/Resources.ko.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.pl.xlf b/src/System.CommandLine/Properties/xlf/Resources.pl.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.pt-BR.xlf b/src/System.CommandLine/Properties/xlf/Resources.pt-BR.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.ru.xlf b/src/System.CommandLine/Properties/xlf/Resources.ru.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.tr.xlf b/src/System.CommandLine/Properties/xlf/Resources.tr.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.zh-Hans.xlf b/src/System.CommandLine/Properties/xlf/Resources.zh-Hans.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.zh-Hant.xlf b/src/System.CommandLine/Properties/xlf/Resources.zh-Hant.xlf
@@ -106,6 +106,11 @@ The value of the variable should be the name of the processes, separated by a se
         <target state="new">Commands:</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpDescriptionTitle">
+        <source>Description:</source>
+        <target state="new">Description:</target>
+        <note />
+      </trans-unit>
       <trans-unit id="HelpOptionDescription">
         <source>Show help and usage information</source>
         <target state="new">Show help and usage information</target>
diff --git a/src/System.CommandLine/Resources.cs b/src/System.CommandLine/Resources.cs
@@ -132,6 +132,12 @@ public virtual string HelpOptionDescription() =>
         public virtual string HelpUsageTitle() =>
             GetResourceString(Properties.Resources.HelpUsageTitle);
 
+        /// <summary>
+        ///   Interpolates values into a localized string similar to Description:.
+        /// </summary>
+        public virtual string HelpDescriptionTitle() =>
+            GetResourceString(Properties.Resources.HelpDescriptionTitle);
+
         /// <summary>
         ///   Interpolates values into a localized string similar to [options].
         /// </summary>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-the-root-command`
	`1`	`+Description:`
`2`	`2`	`Test description`
`3`	`3`
`4`	`4`	`Usage:`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ protected internal void Customize(ISymbol symbol,`
`62`	`62`
`63`	`63`	`protected virtual void AddSynopsis(ICommand command)`
`64`	`64`	`{`
`65`		`- WriteHeading(command.Name, command.Description);`
	`65`	`+ WriteHeading(Resources.Instance.HelpDescriptionTitle(), command.Description);`
`66`	`66`	`Console.Out.WriteLine();`
`67`	`67`	`}`
`68`	`68`