fix: update onReceiveProgress references in docs (#1732)

cgutierr-zgz · web-flow · commit 70cdbf9294eb · 2023-03-12T10:16:38.000+01:00
### New Pull Request Checklist - [x] I have read the [Documentation](https://pub.dev/documentation/dio/latest/) - [x] I have searched for a similar pull request in the [project](https://github.com/cfug/dio/pulls) and found none - [x] I have updated this branch with the latest `main` branch to avoid conflicts (via merge from master or rebase) - [ ] I have added the required tests to prove the fix/feature I'm adding - [x] I have updated the documentation (if necessary) - [ ] I have run the tests without failures - [ ] I have updated the `CHANGELOG.md` in the corresponding package ### Additional context and info (if any)  Small update on the docs making reference to `onProgress` instead of `onReceiveProgress` --------- Signed-off-by: Carlos Gutiérrez Moreno <carlosgutimo.3d@gmail.com>
diff --git a/dio/lib/src/dio.dart b/dio/lib/src/dio.dart
@@ -208,13 +208,13 @@ abstract class Dio {
   ///
   /// [lengthHeader] : The real size of original file (not compressed).
   /// When file is compressed:
-  /// 1. If this value is 'content-length', the `total` argument of `onProgress` will be -1
+  /// 1. If this value is 'content-length', the `total` argument of [onReceiveProgress] will be -1
   /// 2. If this value is not 'content-length', maybe a custom header indicates the original
-  /// file size , the `total` argument of `onProgress` will be this header value.
+  /// file size , the `total` argument of [onReceiveProgress] will be this header value.
   ///
   /// You can also disable the compression by specifying
   /// the 'accept-encoding' header value as '*' to assure the value of
-  /// `total` argument of `onProgress` is not -1. for example:
+  /// `total` argument of [onReceiveProgress] is not -1. for example:
   ///
   /// ```dart
   /// await dio.download(
@@ -223,7 +223,7 @@ abstract class Dio {
   ///   options: Options(
   ///     headers: {HttpHeaders.acceptEncodingHeader: "*"}, // Disable gzip
   ///   ),
-  ///   onProgress: (received, total) {
+  ///   onReceiveProgress: (received, total) {
   ///     if (total != -1) {
   ///       print((received / total * 100).toStringAsFixed(0) + "%");
   ///     }
diff --git a/dio/lib/src/options.dart b/dio/lib/src/options.dart
@@ -24,7 +24,7 @@ enum ResponseType {
   json,
 
   /// Get the response stream without any transformation. The
-  /// Response data will be a `ResponseBody` instance.
+  /// Response data will be a [ResponseBody] instance.
   ///
   ///    Response<ResponseBody> rs = await Dio().get<ResponseBody>(
   ///      url,
@@ -402,8 +402,8 @@ class Options {
   /// that's to say the type of [Response.data] will be List<int>, use `bytes`
   ResponseType? responseType;
 
-  /// `validateStatus` defines whether the request is successful for a given
-  /// HTTP response status code. If `validateStatus` returns `true` ,
+  /// [validateStatus] defines whether the request is successful for a given
+  /// HTTP response status code. If [validateStatus] returns `true` ,
   /// the request will be perceived as successful; otherwise, considered as failed.
   ValidateStatus? validateStatus;
 
diff --git a/dio/lib/src/response.dart b/dio/lib/src/response.dart
@@ -56,7 +56,7 @@ class Response<T> {
   Uri get realUri =>
       redirects.isNotEmpty ? redirects.last.location : requestOptions.uri;
 
-  /// We are more concerned about `data` field.
+  /// We are more concerned about [data] field.
   @override
   String toString() {
     if (data is Map) {
diff --git a/dio/lib/src/transformer.dart b/dio/lib/src/transformer.dart
@@ -13,13 +13,13 @@ import 'utils.dart';
 /// request/response data, you can provide a [Transformer] by your self, and
 /// replace the [DefaultTransformer] by setting the [dio.Transformer].
 abstract class Transformer {
-  /// `transformRequest` allows changes to the request data before it is
+  /// [transformRequest] allows changes to the request data before it is
   /// sent to the server, but **after** the [RequestInterceptor].
   ///
   /// This is only applicable for request methods 'PUT', 'POST', and 'PATCH'
   Future<String> transformRequest(RequestOptions options);
 
-  /// `transformResponse` allows changes to the response data  before
+  /// [transformResponse] allows changes to the response data  before
   /// it is passed to [ResponseInterceptor].
   ///
   /// **Note**: As an agreement, you must return the [response]
