fix: set UsePagerForHelpText to false by default (#347)

Author: natemcmaster

CHANGELOG.md

@@ -2,9 +2,9 @@
 
 [Unreleased changes](https://github.com/natemcmaster/CommandLineUtils/compare/v2.5.1...HEAD):
 
-## [v2.6.0](https://github.com/natemcmaster/CommandLineUtils/compare/v2.5.1...v2.6.0)
+### Changes
 
-* Refactor: obsolete throwOnUnexpectedArg in favor of UnrecognizedArgumentHandling. See https://github.com/natemcmaster/CommandLineUtils/issues/339 for details
+* Disabled the pager for help text by default. To re-enable, set UsePagerForHelpText = true. ([#346])
 
 ### Breaking changes
 
@@ -18,6 +18,11 @@
 [#251]: https://github.com/natemcmaster/CommandLineUtils/issues/251
 [#294]: https://github.com/natemcmaster/CommandLineUtils/issues/294
 [#337]: https://github.com/natemcmaster/CommandLineUtils/issues/337
+[#346]: https://github.com/natemcmaster/CommandLineUtils/issues/346
+
+## [v2.6.0](https://github.com/natemcmaster/CommandLineUtils/compare/v2.5.1...v2.6.0)
+
+* Refactor: obsolete throwOnUnexpectedArg in favor of UnrecognizedArgumentHandling. See https://github.com/natemcmaster/CommandLineUtils/issues/339 for details
 
 ## [v2.5.1](https://github.com/natemcmaster/CommandLineUtils/compare/v2.5.0...v2.5.1)
 

src/CommandLineUtils/Attributes/CommandAttribute.cs

@@ -120,7 +120,7 @@ public string? Name
         /// <summary>
         /// Whether a Pager should be used to display help text.
         /// </summary>
-        public bool UsePagerForHelpText { get; set; } = true;
+        public bool UsePagerForHelpText { get; set; } = false;
 
         /// <summary>
         /// <para>

src/CommandLineUtils/CommandLineApplication.cs

@@ -124,7 +124,7 @@ internal CommandLineApplication(
             ValueParsers = parent?.ValueParsers ?? new ValueParserProvider();
             _parserConfig = parent?._parserConfig ?? new ParserConfig();
             _clusterOptions = parent?._clusterOptions;
-            UsePagerForHelpText = parent?.UsePagerForHelpText ?? true;
+            UsePagerForHelpText = parent?.UsePagerForHelpText ?? false;
 
             _conventionContext = CreateConventionContext();
 

src/CommandLineUtils/PublicAPI.Shipped.txt

@@ -88,8 +88,6 @@ McMaster.Extensions.CommandLineUtils.CommandAttribute.OptionsComparison.get -> S
 McMaster.Extensions.CommandLineUtils.CommandAttribute.OptionsComparison.set -> void
 McMaster.Extensions.CommandLineUtils.CommandAttribute.ParseCulture.get -> System.Globalization.CultureInfo
 McMaster.Extensions.CommandLineUtils.CommandAttribute.ParseCulture.set -> void
-McMaster.Extensions.CommandLineUtils.CommandAttribute.UsePagerForHelpText.get -> bool
-McMaster.Extensions.CommandLineUtils.CommandAttribute.UsePagerForHelpText.set -> void
 McMaster.Extensions.CommandLineUtils.CommandAttribute.ResponseFileHandling.get -> McMaster.Extensions.CommandLineUtils.ResponseFileHandling
 McMaster.Extensions.CommandLineUtils.CommandAttribute.ResponseFileHandling.set -> void
 McMaster.Extensions.CommandLineUtils.CommandAttribute.ShowInHelpText.get -> bool

src/CommandLineUtils/PublicAPI.Unshipped.txt

@@ -1,3 +1,5 @@
+McMaster.Extensions.CommandLineUtils.CommandAttribute.UsePagerForHelpText.get -> bool
+McMaster.Extensions.CommandLineUtils.CommandAttribute.UsePagerForHelpText.set -> void
 McMaster.Extensions.CommandLineUtils.CommandAttribute.UnrecognizedArgumentHandling.set -> void
 McMaster.Extensions.CommandLineUtils.CommandAttribute.UnrecognizedArgumentHandling.get -> McMaster.Extensions.CommandLineUtils.UnrecognizedArgumentHandling
 McMaster.Extensions.CommandLineUtils.CommandLineApplication.CommandLineApplication(McMaster.Extensions.CommandLineUtils.HelpText.IHelpTextGenerator helpTextGenerator, McMaster.Extensions.CommandLineUtils.IConsole console, string workingDirectory) -> void