Removal of `ElectricalComponent.control_mode` is not properly documented

[llucax]

What happened?

The ElectricalComponent.control_mode field and ElectricalComponentControlMode enum were removed in c1de523 (#359, v0.7.0).

Even more, the release notes say:

• Removed:

  • microgrid.components.ComponentStatus, use microgrid.electrical_components.ElectricalComponentControlMode instead

Which makes things more confusing.

What did you expect instead?

ComponentControlMode not to be mentioned at all in release notes, and having some better information about what to do with the removed microgrid.components.ComponentStatus/ElectricalComponent.status.

Affected version(s)

v0.7.0

Affected part(s)

The protocol buffer definition files (part:protobuf), Documentation (part:docs)

Extra information

No response

[llucax]

For now I updated the v0.7.0 release to replace the mention of ControlMode with:

• Removed:

  • microgrid.components.ComponentStatus.

to at least minimize the confusion, but it would be good to give some migration instructions if there are any (like look at the streamed ElectricalComponentStateSnapshot if there is something there, or just saying the functionality was dropped and there is no replacement explicitly if that is the case.

As for the release notes, I guess there isn't much we can do as we can't fix the tag.