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

Add detailed descriptions to enums in package.json #3

Open
jossmoff opened this issue Jul 8, 2022 · 0 comments
Open

Add detailed descriptions to enums in package.json #3

jossmoff opened this issue Jul 8, 2022 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@jossmoff
Copy link
Collaborator

jossmoff commented Jul 8, 2022

To make parsing easier in ConfigurationParser when grouping flags (see esbmc.frontEnd.architecture in package.json) the value of the enum should be the appropriate flag. However, for new users, these flags may not be descriptive enough.

To fix this each enum should have an markdownEnumDescription which accurately describes the type of that flag.

@jossmoff jossmoff added enhancement New feature or request good first issue Good for newcomers labels Jul 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant