Enum with 0 value not shown on Example #379

DimonSmart · 2018-12-07T06:51:44Z

public class MyOption
{
[Option('t', "type", Required = true, HelpText = "My entity")]
public EntityType MyEntityType { get; set; }
public enum MyEntityType
{
X0, // Example for X0 is empty. If change this line to X0 =1, everything is ok
X1,
X2
}

    [Usage(ApplicationAlias = "...")]
    public static IEnumerable<Example> Examples
    {
        get
        {
            foreach (EntityType entityType in Enum.GetValues(typeof(EntityType)))
            {
                yield return new Example(entityType.ToString(), new MyOption { MyEntityType = entityType});
            }
        }
    }
}

The text was updated successfully, but these errors were encountered:

nemec · 2018-12-08T05:31:52Z

This looks like a bug around examples with Required set to true. The example is empty because X0 is the default value for this enum - if you remove Required you'll find that myapp.exe with no arguments sets MyEntityType to X0 automatically. myapp.exe and myapp.exe -t X0 produce the exact same result.

But the example generator should look at whether the option is required and include it whether or not it's the default value.

njqdev · 2019-06-02T18:39:52Z

I took a look at this again and noticed that other value types have the same issue.

   class Options_With_Examples_Having_Default_Values
    {
        [Option('t', "type", HelpText = "My entity")]
        public EntityType MyEntityType { get; set; }

        public enum EntityType
        {
            T0
        }

        [Option('v', "value")]
        public int Value { get; set; }
        [Option('d')]
        public double Double { get; set; }
        [Option('b')]
        public bool Bool { get; set; }

        [Usage(ApplicationAlias = "test.exe")]
        public static IEnumerable<Example> Examples
        {
            get
            {
                yield return new Example("1", new Options_With_Examples_Having_Default_Values { MyEntityType = EntityType.T0 });
                yield return new Example("2", new Options_With_Examples_Having_Default_Values { Value = 1, Double = 0.1, Bool = true });
            }
        }
    }

Returns

1:
  test.exe --type T0
2:
  test.exe --type T0

and the same example with non-default values returns

1:
  test.exe --type T0
2:
  test.exe -d 0,1 --type T0 --value 1

The enum is included in both examples too, because of the change I made in #452.

nemec added the bug label Dec 8, 2018

ericnewton76 added the good first issue label Jan 23, 2019

njqdev mentioned this issue Jun 1, 2019

Fix #379, Enum with 0 value not shown on Example #452

Open

moh-hassan added this to the 2.6 milestone Jun 2, 2019

jdmallen mentioned this issue Jun 6, 2019

Usage Example only treats an Option of type Enum with inner value of 0 as default, regardless of Enum value chosen for Example (demo repo provided) #457

Closed

nemars mentioned this issue Sep 15, 2019

Nullable type #305

Closed

commandlineparser / commandline

Enum with 0 value not shown on Example #379

Enum with 0 value not shown on Example #379

DimonSmart commented Dec 7, 2018

nemec commented Dec 8, 2018 •

edited

njqdev commented Jun 2, 2019

commandlineparser / commandline

Enum with 0 value not shown on Example #379

Enum with 0 value not shown on Example #379

Comments

DimonSmart commented Dec 7, 2018

nemec commented Dec 8, 2018 • edited

njqdev commented Jun 2, 2019

nemec commented Dec 8, 2018 •

edited