Skip to content

Commit

Permalink
fix borked formatting on rooibosC args table in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
georgejecook authored Jun 5, 2019
1 parent 3b5737e commit 464b9cf
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,15 +151,15 @@ There are two ways to invoke RooibosC:
### Description of rooibosC flags


| flag | argument | Fescription |
|--- |--- |:-: |--: |--- |
| `-p` | `--projectPath` | the path to the root of your project. This is used to fix the `pkg:/locations` in rooibos's output. | |
| `-t` | `--testsFilePattern` | array of globs, specifying which test files (i.e. your test _.brs_ files) to include. Relative to projectPath, relative to _"projectPath"_ | |
| `-o` | `--outputPath` | you can also specity the _"outputPath"_. This is where rooibosC will write the map file, and other files it needs which informs rooibos about your tests. It is relative to |
| `-v` | `--isRecordingCodeCoverage` | indicates that we want to generate coverage
| `-s` | `--sourceFilePattern` | array of globs, specifying which files to include/exclude in code coverage. Relative to projectPath. Required if `-v` is set. |
| `-f` | `--showFailuresOnly` | Show results for failed tests, if any. If none fail, then all results are shown |
| `-F` | `--failFast` | Test execution will stop at the first failure |
| flag | argument | Fescription |
|--- |--- |:-: |
| `-p` | `--projectPath` | the path to the root of your project. This is used to fix the `pkg:/locations` in rooibos's output. |
| `-t` | `--testsFilePattern` | array of globs, specifying which test files (i.e. your test _.brs_ files) to include. Relative to projectPath, relative to _"projectPath"_ |
| `-o` | `--outputPath` | you can also specity the _"outputPath"_. This is where rooibosC will write the map file, and other files it needs which informs rooibos about your tests. It is relative to |
| `-v` | `--isRecordingCodeCoverage` | indicates that we want to generate coverage |
| `-s` | `--sourceFilePattern` | array of globs, specifying which files to include/exclude in code coverage. Relative to projectPath. Required if `-v` is set. |
| `-f` | `--showFailuresOnly` | Show results for failed tests, if any. If none fail, then all results are shown |
| `-F` | `--failFast` | Test execution will stop at the first failure |


### Configuring Rooibos's runtime behaviour
Expand Down Expand Up @@ -1146,4 +1146,4 @@ Following is a list of all the hit files, and their coverage % and (hit lines/to

Lastly the files that were not hit at all, during test execution.

The current implementation is capable of tracking lcov style statistics, and this will be implemented in the future.
The current implementation is capable of tracking lcov style statistics, and this will be implemented in the future.

0 comments on commit 464b9cf

Please sign in to comment.