Visitar URL original
docs(cloud_firestore): Remove Incorrect API Documentation (#18423) · firebase/flutterfire@4b1056f · GitHub
Skip to content

Commit 4b1056f

Browse files
authored
docs(cloud_firestore): Remove Incorrect API Documentation (#18423)
* Removed incorrect API documentation from Firestore's document creation methods add() and doc() * Added name to AUTHORS
1 parent 1cf2a5d commit 4b1056f

3 files changed

Lines changed: 1 addition & 9 deletions

File tree

‎AUTHORS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,4 @@ Horváth István <horvatska01@gmail.com>
6666
Liu Zhisong <liuzs0666@gmail.com>
6767
Ievgenii Kovtun <jeka.ns@gmail.com>
6868
Dinu-Stefan Rusu <rusudinustefan@gmail.com>
69+
Marwan Salim Ba Matraf <marwans12@hotmail.com>

‎packages/cloud_firestore/cloud_firestore/lib/src/collection_reference.dart‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,12 @@ abstract class CollectionReference<T extends Object?> implements Query<T> {
2323

2424
/// Returns a `DocumentReference` with an auto-generated ID, after
2525
/// populating it with provided [data].
26-
///
27-
/// The unique key generated is prefixed with a client-generated timestamp
28-
/// so that the resulting list will be chronologically-sorted.
2926
Future<DocumentReference<T>> add(T data);
3027

3128
/// {@template cloud_firestore.collection_reference.doc}
3229
/// Returns a `DocumentReference` with the provided path.
3330
///
3431
/// If no [path] is provided, an auto-generated ID is used.
35-
///
36-
/// The unique key generated is prefixed with a client-generated timestamp
37-
/// so that the resulting list will be chronologically-sorted.
3832
/// {@endtemplate}
3933
DocumentReference<T> doc([String? path]);
4034

‎packages/cloud_firestore/cloud_firestore_platform_interface/lib/src/platform_interface/platform_interface_collection_reference.dart‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,6 @@ abstract class CollectionReferencePlatform extends QueryPlatform {
4343
/// Returns a [DocumentReferencePlatform] with the provided [path].
4444
///
4545
/// If no [path] is provided, an auto-generated ID is used.
46-
///
47-
/// The unique key generated is prefixed with a client-generated timestamp
48-
/// so that the resulting list will be chronologically-sorted.
4946
DocumentReferencePlatform doc([String? path]) {
5047
throw UnimplementedError('doc() is not implemented');
5148
}

0 commit comments

Comments
 (0)