Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
c-dilks committed Apr 23, 2021
1 parent 2cb0f82 commit d687809
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,13 +177,18 @@ Documentation for QADB maintenance and revision
extraneous output in `text/listOfGoldRuns.txt`, such as the COATJAVA
version; repeat the same procedure for
`bin/printGoldenFiles.sh > text/listOfGoldFiles.txt`
* update customized QA criteria sets, such as `OkForAsymmetry`
* use `git status` and `git diff` to review changes, then add and commit to
git, and push to the remote branch
# Change Log
### December 2020
### v1.1.0 - April 2021
* C++ `QADB` class is now in the namespace `QA`
* this is part of a fix for multiple definitions errors from `QADB` functions
### v1.0.0 - December 2020
* `qa.*/` directories have been moved to the subdirectory `qadb/`
`qadb/qa.inbending1` and `qadb/qa.inbending2` have been merged and
renamed to `qadb/qa.rga_inbending`; furthermore, `qadb/qa.outbending`
Expand Down
2 changes: 2 additions & 0 deletions srcC/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ this directory contains the C++ source code to access the QA database
analysis are applied
- usage notes:
- include the `QADB.h` header, then instantiate
- `QADB` is in the `QA` namespace, so you will either need to add
`using namespace QA` or use specifiers, such as `QA::QADB *q`
- the `QADB` class provides several methods for accessing the QA info;
you only need to provide it a run number and event number
- database lookups are only performed as needed, so it is safe to
Expand Down

0 comments on commit d687809

Please sign in to comment.