Skip to content

Rename symbols for better consistency#218

Merged
llucax merged 5 commits into
frequenz-floss:v0.x.xfrom
llucax:renames
Jun 16, 2026
Merged

Rename symbols for better consistency#218
llucax merged 5 commits into
frequenz-floss:v0.x.xfrom
llucax:renames

Conversation

@llucax

@llucax llucax commented Jun 16, 2026

Copy link
Copy Markdown
Contributor
  • Rename ComponentTypes to ElectricalComponentTypes
  • Rename connection source/destination to *_id
  • Rename Lifetime.start/end to start_time/end_time
  • Rename Microgrid.create_timestamp to create_time

Also document the naming conventions hoping it helps keeping consistency in the future.

Part of #203.

llucax added 5 commits June 16, 2026 13:12
Rename the generic component union alias so it carries the same
`Electrical` prefix as its sibling aliases and keep the converter
imports sorted.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Rename the wrapper-facing connection endpoints while keeping the
protobuf field reads and local converter variables unchanged.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Rename the wrapper-facing lifetime attributes to use the `_time` suffix
while keeping protobuf timestamp reads unchanged and updating
validation, helpers, and tests.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Adopt the `_time` wrapper naming convention while keeping the converter
pointed at the protobuf `create_timestamp` field.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
Record the field naming and docstring rules in CONTRIBUTING.md as the
source of truth and point the code-pattern guide to it.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
@llucax llucax requested a review from a team as a code owner June 16, 2026 11:14
@llucax llucax requested review from ela-kotulska-frequenz and removed request for a team June 16, 2026 11:14
@llucax llucax self-assigned this Jun 16, 2026
@llucax llucax added the cmd:skip-release-notes It is not necessary to update release notes for this PR label Jun 16, 2026
@github-actions github-actions Bot added part:docs Affects the documentation part:tests Affects the unit, integration and performance (benchmarks) tests part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) part:microgrid Affects the microgrid protobuf definitions labels Jun 16, 2026
@llucax llucax added this to the v0.4.1 milestone Jun 16, 2026
@llucax llucax enabled auto-merge June 16, 2026 11:15
@llucax llucax added this pull request to the merge queue Jun 16, 2026
Merged via the queue into frequenz-floss:v0.x.x with commit f019eaf Jun 16, 2026
12 of 13 checks passed
@llucax llucax deleted the renames branch June 16, 2026 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cmd:skip-release-notes It is not necessary to update release notes for this PR part:docs Affects the documentation part:microgrid Affects the microgrid protobuf definitions part:tests Affects the unit, integration and performance (benchmarks) tests part:tooling Affects the development tooling (CI, deployment, dependency management, etc.)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants