Skip to content

Commit d004a61

Browse files
committed
DOC: describe "CHECK" evaluatorytype in docstring.
1 parent 82c3a1e commit d004a61

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

src/extensions/wrap_PairQuantity.cpp

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,19 +109,21 @@ No return value.\n\
109109
const char* doc_BasePairQuantity_evaluatortype = "\
110110
String type of preferred evaluation procedure.\n\
111111
\n\
112-
Possible values are 'BASIC' and 'OPTIMIZED'. The value is always\n\
113-
calculated from scratch when 'BASIC'. The 'OPTIMIZED' evaluation\n\
112+
Possible values are 'BASIC', 'OPTIMIZED', and 'CHECK'. The value is\n\
113+
always calculated from scratch when 'BASIC'. The 'OPTIMIZED' evaluation\n\
114114
updates the existing results by recalculating only the contributions\n\
115-
from changed atoms.\n\
115+
from changed atoms. The 'CHECK' evaluation verifies that 'OPTIMIZED'\n\
116+
and 'BASIC' results are equal. It is intended only for debugging\n\
117+
purposes.\n\
116118
\n\
117119
See also evaluatortypeused.\n\
118120
";
119121

120122
const char* doc_BasePairQuantity_evaluatortypeused = "\
121123
String type of evaluation procedure used in the last calculation.\n\
122124
\n\
123-
Possible values are 'BASIC', 'OPTIMIZED', and 'NONE' for calculator\n\
124-
that has not been used yet.\n\
125+
Possible values are 'BASIC', 'OPTIMIZED', 'CHECK', and 'NONE'\n\
126+
when calculator that has not been used yet.\n\
125127
";
126128

127129
const char* doc_BasePairQuantity_maskAllPairs = "\

0 commit comments

Comments
 (0)