Chore: update docstring - #240
Open
fhaver-amsterdam wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates internal documentation in the bridge service to better describe how a boat-charging location’s overall status and max kW are derived from socket data.
Changes:
- Refines the
_get_status_and_kw_from_socketsdocstring to describe location-level status semantics. - Renames a local variable from
availabletooperativefor clearer intent when computing max kW.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+108
to
112
| There are three possible status values for a location: | ||
| - "OPERATIVE": at least one connector at the location is operative | ||
| - "OCCUPIED": all connectors at the location are occupied | ||
| - "INOPERATIVE": no connector is operative and at least one connector is out of order | ||
| - "OCCUPIED": no connector is operative and at least one connector is occupied | ||
| - "INOPERATIVE": all connectors are out of order | ||
|
|
This file contains hidden or 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
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.
Changes
Logic in the function was already like the new logic described in docstrings (and tests are in place to verify this).
Affected services
Definition of done
make openapi-diff)- [ ] Swagger UI up-to-date & tested (make dev)- [ ] Dependencies updated (make requirements)- [ ] Infrastructure config updated (aapp_azure_infra)- [ ] Loadtests for relevant endpoints (aapp_testing_loadtests)After PR created (and deployed on dev):
Other notes
GitHub Copilot was used in writing the code