Skip to content

Commit

Permalink
docs: fix dartdoc warnings (#83)
Browse files Browse the repository at this point in the history
  • Loading branch information
felangel committed Sep 8, 2020
1 parent d98263a commit baf9a66
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# 1.2.5

- docs: dartdoc improvements ([#80](https://github.com/felangel/equatable/issues/80))
- docs: minor inline documentation improvements

# 1.2.4

- fix: `EquatableMixin` stringify respects `EquatableConfig.stringify` ([#81](https://github.com/felangel/equatable/issues/81))
Expand Down
10 changes: 5 additions & 5 deletions lib/src/equatable.dart
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ abstract class Equatable {

/// {@template equatable_props}
/// The list of properies that will be used to determine whether
/// two [Equatable]s are equal.
/// two instances are equal.
/// {@endtemplate}
List<Object> get props;

/// {@template equatable_stringify}
/// If set to `true`, the [toString] method will be overridden to output
/// this [Equatable]'s [props].
/// this instance's [props].
///
/// A global default value for [stringify] can be set using
/// [EquatableConfig.stringify].
/// `EquatableConfig.stringify`.
///
/// If this [Equatable]'s [stringify] is set to null, the value of
/// [EquatableConfig.stringify] will be used instead. That value deafults to
/// If this instance's [stringify] is set to null, the value of
/// `EquatableConfig.stringify` will be used instead. This defaults to
/// `false`.
/// {@endtemplate}
// ignore: avoid_returning_null
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: equatable
description: An abstract class that helps to implement equality without needing to explicitly override == and hashCode.
version: 1.2.4
version: 1.2.5
repository: https://github.com/felangel/equatable
issue_tracker: https://github.com/felangel/equatable/issues
homepage: https://github.com/felangel/equatable
Expand Down

0 comments on commit baf9a66

Please sign in to comment.