Skip to content

Commit d8d7b7c

Browse files
authored
QC-1248 Update QC Flag documentation (#13720)
* QC-1248 Update QC Flag documentation Small updates wrt what is ready to use and some clarifications. * rm trailing whitespace
1 parent 96e4188 commit d8d7b7c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

DataFormats/QualityControl/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Data quality is determined through two methods:
1515

1616
Both methods utilize the same data format for Flags.
1717
During processing (both synchronous and asynchronous), Checks produce Qualities and associate them with Flags.
18-
The Quality Control framework then transmits these Flags to the RCT through a gRPC interface (**not ready yet**, to be done in the scope of QC-978).
18+
The Quality Control framework then transmits these Flags to the RCT through a gRPC interface (more details in QC repository documentation).
1919
Detector experts can then review the automatically generated Flags and make any necessary modifications or additions directly in the RCT.
2020

2121
### Quality Control Flag Structure
@@ -49,12 +49,13 @@ Each Flag Type has the following attributes:
4949
#### Creating and Managing Flag Types
5050

5151
* **FlagTypeFactory** ensures a centralized and consistent list of available Flag Types.
52-
New types can only be created through this factory.
52+
New Flags can only be created through this factory.
5353
* **[flagTypes.csv](etc/flagTypes.csv)** defines the existing Flag Types, including their ID, name, and "bad quality" determinant, factory method name and a switch to deprecate a flag.
5454
The table serves as the source to automatically generate the corresponding methods in FlagTypeFactory.
5555
* **Adding new Flag Types:** If a new issue requires a flag not currently defined, propose the addition by contacting the async QC coordinators.
5656
They have the authority to add new Flag Types to the RCT.
5757
These changes will then be reflected in the [flagTypes.csv](etc/flagTypes.csv) file through a pull request.
58+
Any proposals for new Flag Types should describe the effects on usability of data from analyzer point of view and they should not be detector-specific unless well-argumented.
5859
* **Modification of existing Flag Types:** Existing Flag Types should not be modified in terms of their definition.
5960
Instead, one may create a new Flag Type and mark the existing one as obsolete in the CSV table.
6061
This will add the `[[ deprecated ]]` attribute to the corresponding method.

0 commit comments

Comments
 (0)