fix typo in Fault field faultCurrent (#7)

## Description fix typo in `Fault` field `faultCurrent` ## Changes Made fix typo in `Fault` field `faultCurrent` ## Related Issues N/A ## Checklist - [x] I have used a PR title that is descriptive enough for a release note. - [ ] I have tested these changes locally. - [ ] I have added appropriate tests or updated existing tests. - [ ] I have tested these changes on a dedicated VM or a customer VM [name of the VM] - [ ] I have added appropriate documentation or updated existing documentation. --------- Co-authored-by: tejo <[email protected]> Co-authored-by: Bot <[email protected]> Co-authored-by: chicco785 <[email protected]>
zaphiro-technologies · Oct 17, 2023 · 5b0e7ce · 5b0e7ce
1 parent 8a8a50c
commit 5b0e7ce
Show file tree

Hide file tree

Showing 4 changed files with 97 additions and 93 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,12 +1,16 @@
 # ProtoBuf Release Notes
 
-## 0.0.1-dev - 2023-10-13
+## 0.0.1-dev - 2023-10-17
 
 ### Features
 
 - Notification message: support Trigger requirements (PR #6 by @chicco785)
 - Add protocol buffer to describe faults (PR #3 by @chicco785)
 
+### Bug Fixes
+
+- fix typo in `Fault` field `faultCurrent` (PR #7 by @tejo)
+
 ### Refactoring
 
 - Migrate existing protobuf from

diff --git a/docs/fault.proto.md b/docs/fault.proto.md
@@ -20,7 +20,7 @@
 ## Enum: PhaseConnectedFaultKind
 <div style="font-size: 12px; margin-top: -10px;" class="fqn">FQN: fault.v1.PhaseConnectedFaultKind</div>
 
-<div class="comment"><span></span><br/><span> The type of fault connection among phases.</span><br/><span> </span><br/><span> This message is modeled after [CIM PhaseConnectedFaultKind](https://zepben.github.io/evolve/docs/cim/cim100/TC57CIM/IEC61970/Base/Faults/PhaseConnectedFaultKind).</span><br/><span></span><br/></div>
+<div class="comment"><span></span><br/><span> The type of fault connection among phases.</span><br/><span></span><br/><span> This message is modeled after [CIM PhaseConnectedFaultKind](https://zepben.github.io/evolve/docs/cim/cim100/TC57CIM/IEC61970/Base/Faults/PhaseConnectedFaultKind).</span><br/><span></span><br/></div>
 
 | Name                                              | Ordinal | Description                                                                                                                                                                                                                                                                                                                                                                                                 |
 |---------------------------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -74,7 +74,7 @@ classDiagram
 direction LR
 %% 
 %%  The type of fault connection among phases.
-%%  
+%% 
 %%  This message is modeled after [CIM PhaseConnectedFaultKind](https://zepben.github.io/evolve/docs/cim/cim100/TC57CIM/IEC61970/Base/Faults/PhaseConnectedFaultKind).
 %% 
 
@@ -144,7 +144,7 @@ direction LR
 class Fault {
   + string ID
   + Optional~string~ description
-  + Optional~float~ faulCurrent
+  + Optional~float~ faultCurrent
   + Optional~string~ faultyEquipmentId
   + List~string~ impactedEquipmentIds
   + PhaseConnectedFaultKind kind
@@ -205,7 +205,7 @@ EquipmentFault --> `Fault`
 |----------------------|---------|-------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------|
 | ID                   | 1       | string                  |          | The uuid of the fault.                                                                                                      |
 | description          | 2       | string                  | Optional | The textual description of the fault.                                                                                       |
-| faulCurrent          | 8       | float                   | Optional | The current associated to the fault.                                                                                        |
+| faultCurrent         | 8       | float                   | Optional | The current associated to the fault.                                                                                        |
 | faultyEquipmentId    | 6       | string                  | Optional | The equipment with the fault.                                                                                               |
 | impactedEquipmentIds | 10      | string                  | Repeated | The set of IDs of equipments impacted by the fault.                                                                         |
 | kind                 | 3       | PhaseConnectedFaultKind |          | The kind of phase fault.                                                                                                    |