add comments

2021-06-22 14:20:43 +02:00
parent 00e184f422
commit c987e8b488
18 changed files with 89 additions and 91 deletions
@@ -2,6 +2,12 @@ import 'package:stream_chat/src/client/client.dart';
 import 'package:stream_chat/src/core/error/error.dart';

 /// The retry options
+/// When sending/updating/deleting a message any temporary error will trigger the retry policy
+/// The retry policy exposes 2 methods
+/// - shouldRetry: returns a boolean if the request should be retried
+/// - retryTimeout: How many milliseconds to wait till the next attempt
+///
+/// maxRetryAttempts is a hard limit on maximum retry attempts before giving up
 class RetryPolicy {
  /// Instantiate a new RetryPolicy
  RetryPolicy({