When documenting API changes, particularly breaking changes, follow these practices to ensure clarity and ease of migration: 1. **Group related changes** for better scannability. When multiple methods or functions change in a similar way, format them as a structured list:
When documenting API changes, particularly breaking changes, follow these practices to ensure clarity and ease of migration:
- The following methods now return `EventId` instead of `string`:
- `ClientInterface::captureMessage()`
- `ClientInterface::captureException()`
- `HubInterface::captureEvent()`
- Removed the following methods from `ClientBuilderInterface`, use `ClientBuilderInterface::setTransportFactory()` instead:
- `setUriFactory()`
- `setHttpClient()`
- Refactor to support the [Unified API SDK specs](https://docs.sentry.io/development/sdk-dev/unified-api/)
- Make the `StacktraceBuilder` class part of the public API and add the `Client::getStacktraceBuilder()` method
These practices ensure that developers can easily understand changes, assess impact, and migrate their code efficiently.
Enter the URL of a public GitHub repository