benchmark-wrapper icon indicating copy to clipboard operation
benchmark-wrapper copied to clipboard

Lack of usage documentation

Open dry923 opened this issue 6 years ago • 2 comments

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 avatar Nov 01 '19 14:11 dry923

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

dry923 avatar Nov 01 '19 14:11 dry923

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 avatar Nov 01 '19 14:11 aakarshg