Skip to content

Commit 1cfa03d

Browse files
authored
docs: Remove latin abbreviations from comments. (#1457)
1 parent 9b5ec67 commit 1cfa03d

File tree

6 files changed

+19
-16
lines changed

6 files changed

+19
-16
lines changed

google-cloud-firestore/src/main/java/com/google/cloud/firestore/AggregateField.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ String getAlias() {
137137

138138
/**
139139
* Returns the field on which the aggregation takes place. Returns an empty string if there's no
140-
* field (e.g. for count).
140+
* field (this applies to count).
141141
*/
142142
@Nonnull
143143
String getFieldPath() {

google-cloud-firestore/src/main/java/com/google/cloud/firestore/AggregateQuery.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,8 @@ RunAggregationQueryRequest toProto(@Nullable final ByteString transactionId) {
210210
request.getStructuredAggregationQueryBuilder();
211211
structuredAggregationQuery.setStructuredQuery(runQueryRequest.getStructuredQuery());
212212

213-
// We use this set to remove duplicate aggregates. e.g. `aggregate(sum("foo"), sum("foo"))`
213+
// We use this set to remove duplicate aggregates.
214+
// For example, `aggregate(sum("foo"), sum("foo"))`
214215
HashSet<String> uniqueAggregates = new HashSet<>();
215216
List<StructuredAggregationQuery.Aggregation> aggregations = new ArrayList<>();
216217
int aggregationNum = 0;

google-cloud-firestore/src/main/java/com/google/cloud/firestore/CollectionReference.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ public class CollectionReference extends Query {
5959
}
6060

6161
/**
62-
* The id of a collection refers to the last component of path pointing to a collection, e.g.
63-
* "collection-id" in "projects/project-id/databases/database-id/documents/collection-id".
62+
* The id of a collection refers to the last component of path pointing to a collection, for
63+
* example "collection-id" in "projects/project-id/databases/database-id/documents/collection-id".
6464
*
6565
* @return The ID of the collection.
6666
*/
@@ -121,10 +121,10 @@ public DocumentReference document(@Nonnull String childPath) {
121121
/**
122122
* Retrieves the list of documents in this collection.
123123
*
124-
* <p>The document references returned may include references to "missing documents", i.e.
124+
* <p>The document references returned may include references to "missing documents", specifically
125125
* document locations that have no document present but which contain subcollections with
126-
* documents. Attempting to read such a document reference (e.g. via `get()` or `onSnapshot()`)
127-
* will return a `DocumentSnapshot` whose `exists()` method returns false.
126+
* documents. Attempting to read such a document reference (for example via `get()` or
127+
* `onSnapshot()`) will return a `DocumentSnapshot` whose `exists()` method returns false.
128128
*
129129
* @return The list of documents in this collection.
130130
*/

google-cloud-firestore/src/main/java/com/google/cloud/firestore/DocumentChange.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -73,17 +73,17 @@ public QueryDocumentSnapshot getDocument() {
7373

7474
/**
7575
* The index of the changed document in the result set immediately prior to this DocumentChange
76-
* (i.e. supposing that all prior DocumentChange objects have been applied). Returns -1 for
77-
* 'added' events.
76+
* (specifically, supposing that all prior DocumentChange objects have been applied). Returns -1
77+
* for 'added' events.
7878
*/
7979
public int getOldIndex() {
8080
return oldIndex;
8181
}
8282

8383
/**
84-
* The index of the changed document in the result set immediately after this DocumentChange (i.e.
85-
* supposing that all prior DocumentChange objects and the current DocumentChange object have been
86-
* applied). Returns -1 for 'removed' events.
84+
* The index of the changed document in the result set immediately after this DocumentChange
85+
* (specifically, supposing that all prior DocumentChange objects and the current DocumentChange
86+
* object have been applied). Returns -1 for 'removed' events.
8787
*/
8888
public int getNewIndex() {
8989
return newIndex;

google-cloud-firestore/src/main/java/com/google/cloud/firestore/DocumentReference.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public Firestore getFirestore() {
6868
}
6969

7070
/**
71-
* The id of a document refers to the last component of path pointing to a document, e.g.
71+
* The id of a document refers to the last component of path pointing to a document, for example
7272
* "document-id" in "projects/project-id/databases/database-id/document-id".
7373
*
7474
* @return The ID of the document.

google-cloud-firestore/src/main/java/com/google/cloud/firestore/Query.java

+5-3
Original file line numberDiff line numberDiff line change
@@ -934,7 +934,8 @@ public Query where(com.google.cloud.firestore.Filter filter) {
934934
+ "startAfter(), endBefore() or endAt().");
935935
FilterInternal parsedFilter = parseFilter(filter);
936936
if (parsedFilter.getFilters().isEmpty()) {
937-
// Return the existing query if not adding any more filters (e.g. an empty composite filter).
937+
// Return the existing query if not adding any more filters (for example an empty composite
938+
// filter).
938939
return this;
939940
}
940941
Builder newOptions = options.toBuilder();
@@ -1923,7 +1924,8 @@ boolean shouldRetryQuery(
19231924
*
19241925
* <p>Using the returned query to count the documents is efficient because only the final count,
19251926
* not the documents' data, is downloaded. The returned query can even count the documents if the
1926-
* result set would be prohibitively large to download entirely (e.g. thousands of documents).
1927+
* result set would be prohibitively large to download entirely (for example thousands of
1928+
* documents).
19271929
*
19281930
* @return a query that counts the documents in the result set of this query.
19291931
*/
@@ -1938,7 +1940,7 @@ public AggregateQuery count() {
19381940
*
19391941
* <p>Using this function to perform aggregations is efficient because only the final aggregation
19401942
* values, not the documents' data, is downloaded. This function can even perform aggregations of
1941-
* the documents if the result set would be prohibitively large to download entirely (e.g.
1943+
* the documents if the result set would be prohibitively large to download entirely (for example
19421944
* thousands of documents).
19431945
*
19441946
* @return an {@link AggregateQuery} that performs aggregations on the documents in the result set

0 commit comments

Comments
 (0)