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

Document hpx_run_tests.py #453

Closed
hkaiser opened this issue Jul 14, 2012 · 5 comments
Closed

Document hpx_run_tests.py #453

hkaiser opened this issue Jul 14, 2012 · 5 comments

Comments

@hkaiser
Copy link
Member

hkaiser commented Jul 14, 2012

The documentation needs to have a section describing how to run tests. This is probably best done in the getting started part, where we describe the installation process.

@ghost ghost assigned brycelelbach Jul 14, 2012
@brycelelbach
Copy link
Member

I'm not sure I agree with this, as hpx_run_tests.py is an internal tool, not a user facing one (at least, it shouldn't be). You can add tests through CMake, and run them through the build system; you never need to touch hpx_run_tests.py

@hkaiser
Copy link
Member Author

hkaiser commented Oct 5, 2013

The point of this ticket is to get some developer documentation for times when you are MIA.

@hkaiser hkaiser reopened this Oct 5, 2013
@brycelelbach
Copy link
Member

Where should this documentation be placed?

@ghost ghost assigned brycelelbach Oct 6, 2013
@hkaiser
Copy link
Member Author

hkaiser commented Oct 6, 2013

What about adding some exhaustive comments in the file itself?

@brycelelbach
Copy link
Member

There's already comments in the source code, explaining the input format. All the command line options are documented (--help). I'm not sure what else I should be documenting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants