Skip to content

FAQ, Q7: The example code makes no sense #939

@schittli

Description

@schittli

Hello,

thanks a lot for sharing your great and useful work!

I probably have just a small issue to Q7
https://github.com/commandlineparser/commandline/wiki/How-To#q7
with this question:

How to Display version information on Application startup?

The example code looks like this:

var title=new HeadingInfo(programName:"My supper Application",version:"1.2.3; App-Server:3.6.7");
Console.WriteLine( title );

// The Result will be:
My supper Application 1.2.3; App-Server:3.6.7

This example code makes no sense, because the code does nothing more than we could achieve with this code:

Console.WriteLine( "My supper Application 1.2.3; App-Server:3.6.7" );

The example should display how we can modify the default help engine, including the default --version parameter handling

so that the default help automatically uses this new HeadingInfo 😀

Describe the bug
It is a bug in the sense that the example code in the FAQ unfortunately does not show a relevant use-case on how to use HeadingInfo.

Expected behavior
It would be great if the example code shows how we can slightly modify the default behavior of the help engine.

Thanks a lot, kind regards,
Thomas

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions