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

Lack of usage documentation #90

Open
dry923 opened this issue Nov 1, 2019 · 2 comments
Open

Lack of usage documentation #90

dry923 opened this issue Nov 1, 2019 · 2 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@dry923
Copy link
Member

dry923 commented Nov 1, 2019

When looking to utilize run_snafu for the first time there is no documentation on how to actually run any of the exiting benchmarks. There is some information in the building your own section however there is no "Running Snafu" section. Similarly there is no documentation for each of the wrappers. Lastly, there is no "help" functionality in run_snafu so even just running it blindly doesn't give any helpful information with a failure message describing usage.

@dry923
Copy link
Member Author

dry923 commented Nov 1, 2019

@acalhounRH @aakarshg this valid or am i over/under thinking this?

@aakarshg
Copy link
Contributor

aakarshg commented Nov 1, 2019

This is a valid bug, once the CI is in place I'll adopt the factory method for all the benchmarks and also provide better/some documentation :)

@aakarshg aakarshg added bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants