User guide enhancement suggestion
Roger-Shepherd opened this issue · 2 comments
Roger-Shepherd commented
I was caught out by the naming convention for Python modules. For a speed benchmark the documentation says:
--target-module : This mandatory argument specifies a python module in the pylib directory with definitions of routines to run the benchmark.
I naïvely assumed that "specifies" meant the name of the python file (i.e. xyz.py), it doesn't it means the name of the module (i.e. xyzzy). The documentation might make this explicit for those unfamiliar with Python conventions.
jeremybennett commented
Good point. Would you like to submit a patch to make this clear. Thanks, Jeremy
Roger-Shepherd commented
Done as pull request.