Skip to content

Commit aa75e36

Browse files
committed
Clear release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 0553ddc commit aa75e36

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

RELEASE_NOTES.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22

33
## Summary
44

5-
The main features of this release is the new base class for API clients, gRPC exception wrappers and a new utility function to call stub methods.
5+
<!-- Here goes a general summary of what this release is about -->
66

77
## Upgrading
88

9-
- `channel.parse_grpc_uri()` takes an extra argument, the channel type (which can be either `grpclib.client.Channel` or `grpcio.aio.Channel`).
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1010

1111
## New Features
1212

13-
- Add a `exception` module to provide client exceptions, including gRPC errors with one subclass per gRPC error status code.
14-
- `channel.parse_grpc_uri()` can now be used with `grpcio` too.
15-
- A new `BaseApiClient` class is introduced to provide a base class for API clients. It is strongly recommended to use this class as a base class for all API clients.
16-
- A new `call_stub_method()` function to simplify calling stub methods, converting gRPC errors to `ApiClientError`s, checking if the client is connected and optionally wrapping the response.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
14+
15+
## Bug Fixes
16+
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)