Realign Safety decision points IEC 61508 #439
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
unrelated to safety changes, this was just an update missed previously
ahouseholder
requested review from
sei-vsarvepalli,
cgyarbrough and
j---
as code owners
ahouseholder
added
enhancement
ahouseholder
commented
Feb 6, 2024
| HIGH_1 = SsvcDecisionPointValue( | ||
| name="High", | ||
| key="H", | ||
| description="Mission Prevalence:Essential OR Public Well-Being Impact:(Irreversible)", | ||
| ) | ||
|
|
||
| VERY_HIGH_1 = SsvcDecisionPointValue( |
There was a problem hiding this comment.
This was just reorganizing the file to group LOWs with LOWs, HIGHs with HIGHs, etc.
ahouseholder
commented
Feb 6, 2024
| *Psychological*: Widespread emotional or psychological harm, sufficient to necessitate | ||
| counseling or therapy, impact populations of people. | ||
| """, | ||
| description="Any one or more of these conditions hold. " |
There was a problem hiding this comment.
Fixed formatting enough to make it look ok in markdown. Might still need attention in #380
ahouseholder
commented
Feb 6, 2024
|
|
||
| *Psychological*: N/A | ||
| """, | ||
| description="Any one or more of these conditions hold. " |
There was a problem hiding this comment.
Fixed formatting enough to make it look ok in markdown. Might still need attention in #380
ahouseholder
commented
Feb 6, 2024
| print(SAFETY_IMPACT_1.to_json(indent=2)) | ||
| versions = (SAFETY_IMPACT_1, SAFETY_IMPACT_2) | ||
|
|
||
| print_versions_and_diffs(versions) |
There was a problem hiding this comment.
Running this through print_versions_and_diffs confirmed it deserved a new major version
(patch) Safety Impact v2.0.0 description changed
Safety Impact v2.0.0 key did not change
Safety Impact v2.0.0 version changed from 1.0.0
(major) Safety Impact v2.0.0 removes value None
(major) Safety Impact v2.0.0 removes value Hazardous
(major) Safety Impact v2.0.0 removes value Major
(major) Safety Impact v2.0.0 removes value Minor
(major or minor) Safety Impact v2.0.0 adds value Critical
(major or minor) Safety Impact v2.0.0 adds value Negligible
(major or minor) Safety Impact v2.0.0 adds value Marginal
Safety Impact v2.0.0 value Catastrophic key did not change
(patch) Safety Impact v2.0.0 value Catastrophic description changed
Safety Impact v2.0.0 appears to be a major change
ahouseholder
commented
Feb 6, 2024
| ) | ||
| print_versions_and_diffs(versions) |
There was a problem hiding this comment.
Running this through print_versions_and_diffs confirmed it deserved a new patch version
Public Safety Impact v2.0.1 description did not change
Public Safety Impact v2.0.1 key did not change
Public Safety Impact v2.0.1 version changed from 2.0.0
Public Safety Impact v2.0.1 value names did not change
Public Safety Impact v2.0.1 value Minimal key did not change
Public Safety Impact v2.0.1 value Significant key did not change
(patch) Public Safety Impact v2.0.1 value Minimal description changed
(patch) Public Safety Impact v2.0.1 value Significant description changed
Public Safety Impact v2.0.1 appears to be a patch change
ahouseholder
commented
Feb 6, 2024
|
|
||
| def main(): | ||
| versions = (MISSION_AND_WELL_BEING_IMPACT_1, HUMAN_IMPACT_2) | ||
| versions = (MISSION_AND_WELL_BEING_IMPACT_1, HUMAN_IMPACT_2, HUMAN_IMPACT_2_0_1) |
There was a problem hiding this comment.
Rationale for patch version increment:
Human Impact v2.0.1 description did not change
Human Impact v2.0.1 key did not change
Human Impact v2.0.1 version changed from 2.0.0
Human Impact v2.0.1 value names did not change
Human Impact v2.0.1 value Medium key did not change
Human Impact v2.0.1 value Very High key did not change
Human Impact v2.0.1 value High key did not change
Human Impact v2.0.1 value Low key did not change
(patch) Human Impact v2.0.1 value Medium description changed
Human Impact v2.0.1 value Very High description did not change
(patch) Human Impact v2.0.1 value High description changed
(patch) Human Impact v2.0.1 value Low description changed
Human Impact v2.0.1 appears to be a patch change
j---
approved these changes
Feb 7, 2024
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a (mostly) code-only fix. It includes the following changes:
doctools.pyto generate the new examples, an update to the Mission and Well Being Impact examples is included. (This is a carry over that was missed in Revise compound decision points documentation #428)Documentation changes are limited to adding previous versions of the affected decision points to their corresponding reference pages.
I am deliberately treating this PR to address #311 as distinct from the formatting concern about safety impact as it appears in #380. Fixing both at the same time could make it harder to tell what changed.
Also, I am avoiding updating any additional documentation, including CSV files and trees. Decision models that include any of the safety decision points should be updated eventually, but again that seems like it could make this PR too big if we tried to tackle it all at once. My suggestion is that we leave a separate issue behind to update the safety-dependent decision models to reflect the new versions.