Skip to content

Revise README for HelpLine.HelpBuilder #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonsequitur merged 1 commit into from
Jun 18, 2026
Merged

Revise README for HelpLine.HelpBuilder #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions src/HelpLine.HelpBuilder/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Source-compatible adapter for the System.CommandLine `HelpBuilder` API.

## Background

The `HelpBuilder` and associated types were made internal in System.CommandLine 2.0.0, but during the long beta4 period these types had been public and are wiely used. This library re-publishes them in the `System.CommandLine.Help` namespace so that you can migrate from beta4 to 2.0.0+ with almost no code changes to your help customization.
In System.CommandLine 2.0.0, `HelpBuilder` and associated types were made internal, but during the long beta period these types had been public and were widely used. This library re-publishes them in the `System.CommandLine.Help` namespace so that you can migrate from beta4 to 2.0.0+ with almost no code changes to your help customization.

Over time, this library will be updated to incorporate bug fixes from the internal System.CommandLine `HelpBuilder`. Additional functionality and improvements will be introduced that do not break source code compatibility.

Expand All @@ -16,7 +16,7 @@ using System.CommandLine.Help;

var rootCommand = new RootCommand("sample");

var helpBuilder = new HelpBuilder(120);
var helpBuilder = new HelpBuilder();
helpBuilder.CustomizeLayout(_ =>
[
HelpBuilder.Default.SynopsisSection(),
Expand All @@ -27,5 +27,3 @@ helpBuilder.CustomizeLayout(_ =>

rootCommand.UseHelpBuilder(helpBuilder);
```

`UseHelpBuilder` applies the builder by replacing the `HelpOption.Action` on all instances of `HelpOption` found in the target command or its descendants.
Loading