Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review Naming Conventions #25

Open
gbuenodevsuse opened this issue Jun 24, 2024 · 0 comments
Open

Review Naming Conventions #25

gbuenodevsuse opened this issue Jun 24, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@gbuenodevsuse
Copy link
Collaborator

Rename structs and methods for better general understanding of the code flow, maintenance and organization.

Examples:
-> TelemetryDataItemRow (pkg/lib/items.go) refers to telemetry data being handled by pkg/lib/datastore.go
-> TelemetryDataItem (pkg/lib/items.go) refers to telemetry data being prepared for REST API

Both are being implemented within the same pkg, though they serve different purposes.
Note that later on, TelemetryProcessor also implements the method ToItem, to convert type TelemetryDataItemRow into TelemetryDataItem. At first glance, it isn't clear why this is needed.
This can be confusing at times, and bug prone in the future.

@gbuenodevsuse gbuenodevsuse added the enhancement New feature or request label Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant