stan-dev / stan-dev/cmdstan

Add `help` option to `runCmdStanTests.py`

Open
#650 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation user experience
Dominant language
C++
Stars
238
Forks
106
Avg merge
2h 29m
Merged PRs (30d)
6

Description

Summary:

Add a help option to runCmdStanTests.py. Currently, there's only usage info.

Description:

Stan's runTests.py has a help option that looks like:

$ ./runTests.py -h
usage: runTests.py [-h] [-j N] [-f F [F ...]] [-d] [-m] [--run-all]
                   tests [tests ...]

Generate and run stan math library tests.

positional arguments:
  tests            The path(s) to the test case(s) to run.
                   Example: 'test/unit', 'test/prob', and/or
                            'test/unit/math/prim/scal/fun/abs_test.cpp'

optional arguments:
  -h, --help       show this help message and exit
  -j N             number of cores for make to use
  -f F [F ...]     Only tests with file names matching these will be executed.
                   Example: '-f chol', '-f gpu', '-f prim mat'
  -d, --debug      request additional script debugging output.
  -m, --make-only  Don't run tests, just try to make them.
  --run-all        Don't stop at the first test failure, run all of them.

See more information at: https://github.com/stan-dev/math

The help should look similar.

Current Version:

v2.18.0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading runCmdStanTests.py and inspect its current usage or argument-parsing behavior. Compare it with the help output from Stan's runTests.py, then run runCmdStanTests.py -h to verify that the new help option displays usage, arguments, and exits successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.