Skip to content

member order of sharg::config is not clearΒ #166

Description

@h-2

Does this problem persist on the current main?

  • I have verified the issue on the current main

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

I tried the following code:

parser.add_option(options.k_mer_size, sharg::config{.description = "The size of the k-mer",
                                                    .long_id = "k-mer-size",
                                                    .short_id = 'k',
                                                    .validator = sharg::arithmetic_range_validator{10, 30}});

It fails, because the member order is not alphabetical.

Expected Behavior

I would expect the member order to be the same as in the documentation:
http://docs.seqan.de/sharg/1.0.0/structsharg_1_1config.html

Doxygen was apparently set up to sort the members alphabetically, but the person implementing it had a different order in mind πŸ˜‰ This means that the user needs to look up the source-code.

The easiest fix is to also sort alphabetically in the code. [That's also an easy rule-of-thumb for your users, so they don't need to look it up!]

Steps To Reproduce

foo

Environment

sharg-1.0.0

Anything else?

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions