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

User guide enhancement suggestion #84

Open
Roger-Shepherd opened this issue Aug 4, 2020 · 2 comments
Open

User guide enhancement suggestion #84

Roger-Shepherd opened this issue Aug 4, 2020 · 2 comments
Labels
bug Something isn't working

Comments

@Roger-Shepherd
Copy link
Contributor

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
Copy link
Collaborator

Good point. Would you like to submit a patch to make this clear. Thanks, Jeremy

@Roger-Shepherd
Copy link
Contributor Author

Done as pull request.

@jeremybennett jeremybennett added the bug Something isn't working label Aug 9, 2020
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

No branches or pull requests

2 participants