Skip to content

Commit b24ff6b

Browse files
committed
Clean release notes formatting
This will be rendered by GitHub releases, which preserves new lines, so it looks better if we don't manually wrap. Also remove placeholders, as the release will happen soon and will not get new features or content for the currently empty sections. Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
1 parent 100d3bc commit b24ff6b

1 file changed

Lines changed: 2 additions & 20 deletions

File tree

‎RELEASE_NOTES.md‎

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,10 @@
11
# Dispatch Highlevel Interface Release Notes
22

3-
## Summary
4-
5-
<!-- Here goes a general summary of what this release is about -->
6-
7-
## Upgrading
8-
9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10-
11-
## New Features
12-
13-
<!-- Here goes the main new features and examples or instructions on how to use them -->
14-
153
## Enhancements
164

175
- Improved docstring documentation across the project.
186

197
## Bug Fixes
208

21-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
22-
23-
* Fixed documentation cross-references to dependencies by updating the
24-
mkdocstrings inventories to match the minimum dependency versions and
25-
adding the missing `frequenz-client-base` inventory.
26-
* Declared the missing direct dependencies `frequenz-client-common`,
27-
`frequenz-core` and `grpcio`, which were previously only pulled in
28-
indirectly through `frequenz-client-dispatch`.
9+
* Fixed documentation cross-references to dependencies by updating the mkdocstrings inventories to match the minimum dependency versions and adding the missing `frequenz-client-base` inventory.
10+
* Declared the missing direct dependencies `frequenz-client-common`, `frequenz-core` and `grpcio`, which were previously only pulled in indirectly through `frequenz-client-dispatch`.

0 commit comments

Comments
 (0)