Clean up and reformat the release notes for v1alpha8 #401
Conversation
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
Signed-off-by: Tiyash Basu <[email protected]>
Contributor
There was a problem hiding this comment.
Pull Request Overview
The PR cleans up and reformats the RELEASE_NOTES.md for the v1alpha8 release, reorganizing the breaking changes into a clearer structure.
- Updated the summary to introduce v1alpha8 and highlight major breaking changes.
- Refactored the Upgrading section to list removed components and renamed symbols.
- Consolidated change categories under a single coherent layout.
Comments suppressed due to low confidence (3)
RELEASE_NOTES.md:7
- [nitpick] Consider adding a subheading like '### Breaking Changes' before the lists of removed and renamed items to clearly separate upgrade instructions from other content.
## Upgrading
RELEASE_NOTES.md:11
- [nitpick] Rather than using a list item for 'Removed:', consider using a markdown subheading (e.g., '#### Removed') or bold text to improve readability of the breaking changes section.
- Removed:
RELEASE_NOTES.md:13
- [nitpick] The nested list marker '+' mixed with '-' and '' in other parts can be confusing; consider using a consistent marker (e.g., all '-' or all '') throughout.
+ `electrical_components.Fuse`
llucax
reviewed
Jul 10, 2025
| * `ElectricalComponentCategorySpecificInfo.kind.voltage_transformer` to `ElectricalComponentCategorySpecificInfo.kind.power_transformer` | ||
| * `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER` to `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER` | ||
|
|
||
| + `types`: |
Contributor
There was a problem hiding this comment.
This should probably be type, we can fix it in the GitHub release notes at least.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.