Skip to content

Commit 0dfe286

Browse files
committed
refactor(migration): update documentation and remove ignored lint
- Remove comment_references lint ignore - Update migration documentation to use prDate and prSummary instead of version and description
1 parent 1fb7ad1 commit 0dfe286

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

lib/src/database/migration.dart

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
// ignore_for_file: comment_references
2-
31
import 'package:logging/logging.dart';
42
import 'package:mongo_dart/mongo_dart.dart';
53

64
/// {@template migration}
75
/// An abstract base class for defining database migration scripts.
86
///
97
/// Each concrete migration must extend this class and implement the [up] and
10-
/// [down] methods. Migrations are identified by a unique [version] string
11-
/// (following the `YYYYMMDDHHMMSS` format) and a [description].
8+
/// [down] methods. Migrations are identified by a unique [prDate] string
9+
/// (following the `YYYYMMDDHHMMSS` format) and a [prSummary].
1210
///
1311
/// Implementations of [up] and [down] must be **idempotent**, meaning they
1412
/// can be safely run multiple times without causing errors or incorrect data.

0 commit comments

Comments
 (0)