Skip to content
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.

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

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

Closed
2 tasks done
h-2 opened this issue Nov 23, 2022 · 2 comments · Fixed by #167
Closed
2 tasks done

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

h-2 opened this issue Nov 23, 2022 · 2 comments · Fixed by #167
Labels
bug Something isn't working

Comments

@h-2
Copy link
Member

h-2 commented Nov 23, 2022

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

@h-2 h-2 added the bug Something isn't working label Nov 23, 2022
@eseiler
Copy link
Member

eseiler commented Dec 3, 2022

Due to sickness and holiday, we haven't discussed this yet, but I hope we are all present on Monday.

@smehringer
Copy link
Member

Core Meeting 05.12.2022

We will keep the code as is. We will disable alphabetical sorting of the member briefs in doxygen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants