Prepare readme for release#178
Merged
Marenz merged 1 commit intofrequenz-floss:v0.x.xfrom Jun 4, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the release notes to describe new subtype support in the upcoming API release and refreshes the example usage of TargetCategories.
- Adds a summary explaining that subtypes can be read but not yet set.
- Updates the example in the Upgrading section to use
ComponentCategory.INVERTERinstead ofComponentCategory.SOLAR.
Comments suppressed due to low confidence (1)
RELEASE_NOTES.md:5
- [nitpick] Consider rephrasing this sentence for clarity and flow. For example: 'While the new
TargetCategoryclass supports subtypes, only reading them is currently available; setting subtypes will be introduced in a future release.'
This release adds support for an upcoming API change that allows specifying subtypes for target categories. While you can already use the new `TargetCategory` class even with subtypes, actually setting them is not yet supported by the client or service, _only reading_.
Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
llucax
approved these changes
Jun 4, 2025
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
2 participants
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.
No description provided.