Merge pull request #2469 from KathleenDollard/m-cleanup

Misc cleanup

Author: mhutch

src/System.CommandLine.Subsystems/CompletionSubsystem.cs

@@ -6,6 +6,15 @@
 
 namespace System.CommandLine;
 
+// Notes from Chet's work on static shells and further thoughts
+//    - Chet has work he can later upstream for completion script creation - static when it can be
+//    - Completions need to know - what it is, whether it is static or dynamic, and how many items would be in the list.
+//      - Not sure whether these need to be in the Completer or the trait
+//    - Validation can have many validators per type. Completions may need to have a single one.
+//    - Probably two steps - determining the available values and matching the current word
+//      - The code in CompletionContext of main/Extended to get current word requires tokens and is pretty gnarly 
+//    - File and directory are special as they can get handed off to shell ro the work
+
 public class CompletionSubsystem : CliSubsystem
 {
     public CompletionSubsystem(IAnnotationProvider? annotationProvider = null)

src/System.CommandLine.Subsystems/HelpSubsystem.cs

@@ -18,6 +18,14 @@ namespace System.CommandLine;
 public class HelpSubsystem(IAnnotationProvider? annotationProvider = null)
     : CliSubsystem(HelpAnnotations.Prefix, SubsystemKind.Help, annotationProvider)
 {
+    /// <summary>
+    /// Gets the help option, which allows the user to customize
+    /// </summary>
+    /// <remarks>
+    /// By design, the user can modify the help option but not replace it. This allows us to 
+    /// do the fastest possible lookup of whether help was called, and we aren't clear why 
+    /// the option would need to be replaced
+    /// </remarks>
     public CliOption<bool> HelpOption { get; } = new CliOption<bool>("--help", ["-h"])
     {
         // TODO: Why don't we accept bool like any other bool option?

src/System.CommandLine.Subsystems/Subsystems/Annotations/VersionAnnotations.cs

@@ -9,6 +9,4 @@ namespace System.CommandLine.Subsystems.Annotations;
 public static class VersionAnnotations
 {
     public static string Prefix { get; } = nameof(SubsystemKind.Version);
-
-    public static AnnotationId<string> Version { get; } = new(Prefix, nameof(Version));
 }