Skip to content

Fix broken documentation found while reviewing C# docs. #670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 30, 2019
Merged

Fix broken documentation found while reviewing C# docs. #670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentSnapshot.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

/**
* A {@code DocumentSnapshot} contains data read from a document in your Cloud Firestore database.
* The data can be extracted with the {@link #getData()} or {@link #get()} methods.
* The data can be extracted with the {@link #getData()} or {@link #get(String)} methods.
*
* <p>If the {@code DocumentSnapshot} points to a non-existing document, {@link #getData()} and its
* corresponding methods will return {@code null}. You can always explicitly check for a document's
Expand Down
2 changes: 1 addition & 1 deletion firebase-firestore/src/main/java/com/google/firebase/firestore/QuerySnapshot.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public Query getQuery() {
return originalQuery;
}

/** @return The metadata for this document snapshot. */
/** @return The metadata for this query snapshot. */
@NonNull
public SnapshotMetadata getMetadata() {
return metadata;
Expand Down
12 changes: 6 additions & 6 deletions firebase-firestore/src/main/java/com/google/firebase/firestore/SetOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ public static SetOptions merge() {
}

/**
* Changes the behavior of {@code set()} calls to only replace the fields under fieldPaths. Any
* field that is not specified in fieldPaths is ignored and remains untouched.
* Changes the behavior of {@code set()} calls to only replace the given fields. Any field that is
* not specified in {@code fields} is ignored and remains untouched.
*
* <p>It is an error to pass a {@code SetOptions} object to a {@code set()} call that is missing a
* value for any of the fields specified here.
Expand All @@ -88,8 +88,8 @@ public static SetOptions mergeFields(@NonNull List<String> fields) {
}

/**
* Changes the behavior of {@code set()} calls to only replace the fields under fieldPaths. Any
* field that is not specified in fieldPaths is ignored and remains untouched.
* Changes the behavior of {@code set()} calls to only replace the given fields. Any field that is
* not specified in {@code fields} is ignored and remains untouched.
*
* <p>It is an error to pass a {@code SetOptions} object to a {@code set()} call that is missing a
* value for any of the fields specified here.
Expand All @@ -109,8 +109,8 @@ public static SetOptions mergeFields(String... fields) {
}

/**
* Changes the behavior of {@code set()} calls to only replace the fields under fieldPaths. Any
* field that is not specified in fieldPaths is ignored and remains untouched.
* Changes the behavior of {@code set()} calls to only replace the given fields. Any field that is
* not specified in {@code fields} is ignored and remains untouched.
*
* <p>It is an error to pass a {@code SetOptions} object to a {@code set()} call that is missing a
* value for any of the fields specified here in its to data argument.
Expand Down