Skip to content

Commit

Permalink
Merge pull request segmentio#85 from b099l3/patch-2
Browse files Browse the repository at this point in the history
docs: fixed local links in README.md
  • Loading branch information
MichaelGHSeg authored Jul 1, 2024
2 parents d002f65 + ca91bb7 commit 3800da7
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ LogFactory.logger = CustomLogger();

You can handle analytics client errors through the `errorHandler` option.

The error handler configuration receives a function which will get called whenever an error happens on the analytics client. It will receive an Exception, that will extend one of the errors from [errors.dart](packages/core/lib/errors.dart).
The error handler configuration receives a function which will get called whenever an error happens on the analytics client. It will receive an Exception, that will extend one of the errors from [errors.dart](./lib/errors.dart).

You can use this error handling to trigger different behaviours in the client when a problem occurs. For example if the client gets rate limited you could use the error handler to swap flush policies to be less aggressive:

Expand Down Expand Up @@ -555,7 +555,7 @@ final analytics = createClient(Configuration(writeKey),

### Reporting errors from plugins

Plugins can also report errors to the handler by using the [`.error`](packages/core/lib/analytics.dart#L52) function of the analytics client, we recommend using the `PluginError` for consistency, and attaching the `innerError` with the actual exception that was hit:
Plugins can also report errors to the handler by using the [`.error`](./lib/analytics.dart#L55) function of the analytics client, we recommend using the `PluginError` for consistency, and attaching the `innerError` with the actual exception that was hit:

```dart
import 'package:segment_analytics/errors.dart';
Expand All @@ -573,15 +573,15 @@ try {

## Example App

See the [example app](./example/README.md) to check a full test app of how to integrate Analytics-Flutter into your own Flutter app.
See the [example app](../../example/README.md) to check a full test app of how to integrate Analytics-Flutter into your own Flutter app.

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
See the [contributing guide](./CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## Code of Conduct

Before contributing, please also see our [code of conduct](CODE_OF_CONDUCT.md).
Before contributing, please also see our [code of conduct](../../CODE_OF_CONDUCT.md).

## License

Expand Down

0 comments on commit 3800da7

Please sign in to comment.