Fix doc for sensitivity thresholds #2511
Conversation
Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>
| @@ -94,7 +94,8 @@ public SensitivityAnalysisParameters setVoltageVoltageSensitivityValueThreshold( | |||
|
|
|||
| /** | |||
| * VoltageVoltageSensitivityValueThreshold is the threshold under which sensitivity values having | |||
| * variable type BUS_TARGET_VOLTAGE and function type BUS_VOLTAGE will be filtered from the analysis results. | |||
| * variable type BUS_TARGET_VOLTAGE | |||
There was a problem hiding this comment.
No no, no mistake here indeed for me.
| @@ -109,7 +110,7 @@ public SensitivityAnalysisParameters setFlowVoltageSensitivityValueThreshold(dou | |||
| /** | |||
| * FlowVoltageSensitivityValueThreshold is the threshold under which sensitivity values having | |||
| * variable type among INJECTION_REACTIVE_POWER and BUS_TARGET_VOLTAGE | |||
| * and function type among BUS_VOLTAGE, BRANCH_REACTIVE_POWER_1/2/3 and BRANCH_CURRENT_1/2/3 | |||
There was a problem hiding this comment.
No error here too, maybe just some clarifications...
There was a problem hiding this comment.
FlowVoltageSensitivityValueThreshold is the threshold under which sensitivity values having variable type among INJECTION_REACTIVE_POWER and function type among BUS_VOLTAGE or variable type among BUS_TARGET_VOLTAGE and function type among BRANCH_REACTIVE_POWER_1/2/3 and BRANCH_CURRENT_1/2/3.
Is it better for you?
|
@obrix do you want to clarify something finally? |
|
@geofjamg @annetill The issue was that the couple BUS_TARGET_VOLTAGE/BUS_VOLTAGE is documented as filtered by flowVoltage threshold and voltageVoltageThreshold, where in reality only voltageVoltageThreshold filters those kind of sensitivity values. Do you prefer another way to modify the documentation from the one I used or do you feel it is already explicit enough without modification ? |
|
Kudos, SonarCloud Quality Gate passed!
|
Signed-off-by: Bertrand Rix <bertrand.rix@artelys.com>
Fix doc for sensitivity thresholds
Please check if the PR fulfills these requirements (please use
'[x]'to check the checkboxes, or submit the PR and then click the checkboxes)Does this PR already have an issue describing the problem ? If so, link to this issue using
'#XXX'and skip the restWhat kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
What is the current behavior? (You can also link to an open issue here)
What is the new behavior (if this is a feature change)?
Does this PR introduce a breaking change or deprecate an API? If yes, check the following:
Other information:
(if any of the questions/checkboxes don't apply, please delete them entirely)