Skip to content

Commit 616c820

Browse files
committed
Update CHANGELOG and release notes for 2.3.3 and update API docs
1 parent 69e9ce5 commit 616c820

File tree

3 files changed

+62
-1
lines changed

3 files changed

+62
-1
lines changed

CHANGELOG.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Changelog
22

3+
## [v2.3.3]
4+
5+
Enhancements:
6+
* [@mpipo]: add an API to disable the pager for help text (CommandLineApplication.UsePagerForHelpText) ([#216])
7+
8+
[#216]: https://github.com/natemcmaster/CommandLineUtils/pull/216
9+
310
## [v2.3.2]
411

512
Enhancements:
@@ -321,13 +328,15 @@ Other:
321328
[@liamdawson]: https://github.com/liamdawson
322329
[@lvermeulen]: https://github.com/lvermeulen
323330
[@MadbHatter]: https://github.com/MadbHatter
331+
[@mpipo]: https://github.com/mpipo
324332
[@rlvandaveer]: https://github.com/rlvandaveer
325333
[@rmcc13]: https://github.com/rmcc13
326334
[@SeanFeldman]: https://github.com/SeanFeldman
327335
[@sebastienros]: https://github.com/sebastienros
328336
[@TheConstructor]: https://github.com/TheConstructor
329337

330-
[Unreleased]: https://github.com/natemcmaster/CommandLineUtils/compare/v2.3.2...HEAD
338+
[Unreleased]: https://github.com/natemcmaster/CommandLineUtils/compare/v2.3.3...HEAD
339+
[v2.3.3]: https://github.com/natemcmaster/CommandLineUtils/compare/v2.3.2...v2.3.3
331340
[v2.3.2]: https://github.com/natemcmaster/CommandLineUtils/compare/v2.3.1...v2.3.2
332341
[v2.3.1]: https://github.com/natemcmaster/CommandLineUtils/compare/v2.3.0...v2.3.1
333342
[v2.3.0]: https://github.com/natemcmaster/CommandLineUtils/compare/v2.2.5...v2.3.0

docs/v2.3/api/McMaster.Extensions.CommandLineUtils.CommandLineApplication.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ items:
7474
- McMaster.Extensions.CommandLineUtils.CommandLineApplication.ShowVersion
7575
- McMaster.Extensions.CommandLineUtils.CommandLineApplication.System#IServiceProvider#GetService(System.Type)
7676
- McMaster.Extensions.CommandLineUtils.CommandLineApplication.ThrowOnUnexpectedArgument
77+
- McMaster.Extensions.CommandLineUtils.CommandLineApplication.UsePagerForHelpText
7778
- McMaster.Extensions.CommandLineUtils.CommandLineApplication.ValidationErrorHandler
7879
- McMaster.Extensions.CommandLineUtils.CommandLineApplication.Validators
7980
- McMaster.Extensions.CommandLineUtils.CommandLineApplication.ValueParsers
@@ -818,6 +819,43 @@ items:
818819
- set
819820
modifiers.vb:
820821
- Public
822+
- uid: McMaster.Extensions.CommandLineUtils.CommandLineApplication.UsePagerForHelpText
823+
commentId: P:McMaster.Extensions.CommandLineUtils.CommandLineApplication.UsePagerForHelpText
824+
id: UsePagerForHelpText
825+
parent: McMaster.Extensions.CommandLineUtils.CommandLineApplication
826+
langs:
827+
- csharp
828+
- vb
829+
name: UsePagerForHelpText
830+
nameWithType: CommandLineApplication.UsePagerForHelpText
831+
fullName: McMaster.Extensions.CommandLineUtils.CommandLineApplication.UsePagerForHelpText
832+
type: Property
833+
source:
834+
remote:
835+
path: src/CommandLineUtils/CommandLineApplication.cs
836+
branch: master
837+
repo: https://github.com/natemcmaster/CommandLineutils
838+
id: UsePagerForHelpText
839+
path: ../src/CommandLineUtils/CommandLineApplication.cs
840+
startLine: 175
841+
assemblies:
842+
- McMaster.Extensions.CommandLineUtils
843+
namespace: McMaster.Extensions.CommandLineUtils
844+
summary: "\nWhether a Pager should be used to display help text.\n"
845+
example: []
846+
syntax:
847+
content: public bool UsePagerForHelpText { get; set; }
848+
parameters: []
849+
return:
850+
type: System.Boolean
851+
content.vb: Public Property UsePagerForHelpText As Boolean
852+
overload: McMaster.Extensions.CommandLineUtils.CommandLineApplication.UsePagerForHelpText*
853+
modifiers.csharp:
854+
- public
855+
- get
856+
- set
857+
modifiers.vb:
858+
- Public
821859
- uid: McMaster.Extensions.CommandLineUtils.CommandLineApplication.IsShowingInformation
822860
commentId: P:McMaster.Extensions.CommandLineUtils.CommandLineApplication.IsShowingInformation
823861
id: IsShowingInformation
@@ -5973,6 +6011,16 @@ references:
59736011
name: ThrowOnUnexpectedArgument
59746012
nameWithType: CommandLineApplication.ThrowOnUnexpectedArgument
59756013
fullName: McMaster.Extensions.CommandLineUtils.CommandLineApplication.ThrowOnUnexpectedArgument
6014+
- uid: McMaster.Extensions.CommandLineUtils.CommandLineApplication.UsePagerForHelpText*
6015+
commentId: P:McMaster.Extensions.CommandLineUtils.CommandLineApplication.UsePagerForHelpText
6016+
name: UsePagerForHelpText
6017+
nameWithType: CommandLineApplication.UsePagerForHelpText
6018+
fullName: McMaster.Extensions.CommandLineUtils.CommandLineApplication.UsePagerForHelpText
6019+
- uid: McMaster.Extensions.CommandLineUtils.CommandLineApplication.UsePagerForHelpText*
6020+
commentId: Overload:McMaster.Extensions.CommandLineUtils.CommandLineApplication.UsePagerForHelpText
6021+
name: UsePagerForHelpText
6022+
nameWithType: CommandLineApplication.UsePagerForHelpText
6023+
fullName: McMaster.Extensions.CommandLineUtils.CommandLineApplication.UsePagerForHelpText
59766024
- uid: McMaster.Extensions.CommandLineUtils.CommandLineApplication.OptionHelp
59776025
commentId: P:McMaster.Extensions.CommandLineUtils.CommandLineApplication.OptionHelp
59786026
parent: McMaster.Extensions.CommandLineUtils.CommandLineApplication

src/CommandLineUtils/releasenotes.props

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
<Project>
22
<PropertyGroup>
3+
<PackageReleaseNotes Condition="'$(VersionPrefix)' == '2.3.3'">
4+
Enhancement:
5+
* @mpipo: add an API to disable the pager for help text (CommandLineApplication.UsePagerForHelpText)
6+
</PackageReleaseNotes>
37
<PackageReleaseNotes Condition="'$(VersionPrefix)' == '2.3.2'">
48
Enhancement:
59
* @rlvandaveer: honor attributes on classes which implement ValidationAttribute

0 commit comments

Comments
 (0)