Skip to content

Commit

Permalink
doc: clarify default run range
Browse files Browse the repository at this point in the history
  • Loading branch information
c-dilks committed Dec 5, 2023
1 parent 0df2bb9 commit bb1a419
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions qa-detectors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ The specifications are specified by text files in [the `cuts` directory](cuts).
- `spec` key: apply the cut to a specific timeline _e.g._, sector or layer
- `color` key: customize the cut line color
- `run_range` key: apply to a specific run range, _e.g.,_, `run_range:5000:6000` will apply to runs $\in[5000,6000]$
- runs outside of all `run_range` specifiers will use the default cuts (the one(s) without the `run_range` specifier)
- all cuts should have a default version with no `run_range`
- comments can be added using the symbol `#`, which is useful for commenting out timelines, especially when debugging a particular timeline
- other files in `cuts/` may override the default file
- **this is a deprecated feature**; it is preferred to use `run_range` keywords (see above)
Expand Down

0 comments on commit bb1a419

Please sign in to comment.