Clarify multi db documentation #5158
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Javadoc Changes:--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/FirebaseFirestore.html 2023-07-12 15:34:15.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/FirebaseFirestore.html 2023-07-12 15:27:43.000000000 +0000
@@ -652,14 +652,14 @@
<h3 class="api-name" id="getInstance()">getInstance</h3>
<pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html#getInstance()">getInstance</a>()</pre>
<p>Returns the default <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance for the default <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>. </p>
- <p>Returns the same instance for all invocations. If no instance exists, initializes a new instance with default settings.</p>
+ <p>Returns the same instance for all invocations. If no instance exists, initializes a new instance.</p>
<p>The <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance.</p>
</div>
<div class="api-item"><a name="getInstance-com.google.firebase.FirebaseApp-"></a><a name="getinstance"></a>
<h3 class="api-name" id="getInstance(com.google.firebase.FirebaseApp)">getInstance</h3>
<pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(com.google.firebase.FirebaseApp)">getInstance</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a> app)</pre>
<p>Returns the default <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance for the provided <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>. </p>
- <p>For a given <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>, invocation always returns the same instance. If no instance exists, initializes a new instance with default settings.</p>
+ <p>For a given <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>, invocation always returns the same instance. If no instance exists, initializes a new instance.</p>
<p>The <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -676,7 +676,7 @@
<tr>
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a> app</code></td>
<td>
- <p>- The <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> instance that the returned <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance is associated with.</p>
+ <p>The <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> instance that the returned <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance is associated with.</p>
</td>
</tr>
</tbody>
@@ -687,7 +687,7 @@
<h3 class="api-name" id="getInstance(java.lang.String)">getInstance</h3>
<pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(java.lang.String)">getInstance</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> database)</pre>
<p>Returns the <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance for the default <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>. </p>
- <p>Returns the same instance for all invocations given the same database parameter. If no instance exists, initializes a new instance with default settings.</p>
+ <p>Returns the same instance for all invocations given the same database parameter. If no instance exists, initializes a new instance.</p>
<p>The <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -704,7 +704,7 @@
<tr>
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> database</code></td>
<td>
- <p>- The name of database.</p>
+ <p>The database ID.</p>
</td>
</tr>
</tbody>
@@ -715,7 +715,7 @@
<h3 class="api-name" id="getInstance(com.google.firebase.FirebaseApp,java.lang.String)">getInstance</h3>
<pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(com.google.firebase.FirebaseApp,java.lang.String)">getInstance</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a> app, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> database)</pre>
<p>Returns the <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance for the provided <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>. </p>
- <p>Returns the same instance for all invocations given the same <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> and database parameter. If no instance exists, initializes a new instance with default settings.</p>
+ <p>Returns the same instance for all invocations given the same <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> and database parameter. If no instance exists, initializes a new instance.</p>
<p>The <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -732,13 +732,13 @@
<tr>
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a> app</code></td>
<td>
- <p>- The <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> instance that the returned <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance is associated with.</p>
+ <p>The <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> instance that the returned <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance is associated with.</p>
</td>
</tr>
<tr>
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> database</code></td>
<td>
- <p>- The name of database.</p>
+ <p>The database ID.</p>
</td>
</tr>
</tbody>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FirebaseFirestore.html 2023-07-12 15:34:15.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FirebaseFirestore.html 2023-07-12 15:27:43.000000000 +0000
@@ -652,14 +652,14 @@
<h3 class="api-name" id="getInstance()">getInstance</h3>
<pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance()">getInstance</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></pre>
<p>Returns the default <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance for the default <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>. </p>
- <p>Returns the same instance for all invocations. If no instance exists, initializes a new instance with default settings.</p>
+ <p>Returns the same instance for all invocations. If no instance exists, initializes a new instance.</p>
<p>The <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance.</p>
</div>
<div class="api-item"><a name="getInstance-com.google.firebase.FirebaseApp-"></a><a name="getinstance"></a>
<h3 class="api-name" id="getInstance(com.google.firebase.FirebaseApp)">getInstance</h3>
<pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(com.google.firebase.FirebaseApp)">getInstance</a>(app: <a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></pre>
<p>Returns the default <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance for the provided <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>. </p>
- <p>For a given <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>, invocation always returns the same instance. If no instance exists, initializes a new instance with default settings.</p>
+ <p>For a given <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>, invocation always returns the same instance. If no instance exists, initializes a new instance.</p>
<p>The <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -676,7 +676,7 @@
<tr>
<td><code>app: <a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code></td>
<td>
- <p>- The <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> instance that the returned <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance is associated with.</p>
+ <p>The <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> instance that the returned <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance is associated with.</p>
</td>
</tr>
</tbody>
@@ -687,7 +687,7 @@
<h3 class="api-name" id="getInstance(java.lang.String)">getInstance</h3>
<pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(java.lang.String)">getInstance</a>(database: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></pre>
<p>Returns the <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance for the default <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>. </p>
- <p>Returns the same instance for all invocations given the same database parameter. If no instance exists, initializes a new instance with default settings.</p>
+ <p>Returns the same instance for all invocations given the same database parameter. If no instance exists, initializes a new instance.</p>
<p>The <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -704,7 +704,7 @@
<tr>
<td><code>database: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
<td>
- <p>- The name of database.</p>
+ <p>The database ID.</p>
</td>
</tr>
</tbody>
@@ -715,7 +715,7 @@
<h3 class="api-name" id="getInstance(com.google.firebase.FirebaseApp,java.lang.String)">getInstance</h3>
<pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(com.google.firebase.FirebaseApp,java.lang.String)">getInstance</a>(app: <a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a>, database: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></pre>
<p>Returns the <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance for the provided <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>. </p>
- <p>Returns the same instance for all invocations given the same <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> and database parameter. If no instance exists, initializes a new instance with default settings.</p>
+ <p>Returns the same instance for all invocations given the same <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> and database parameter. If no instance exists, initializes a new instance.</p>
<p>The <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
@@ -732,13 +732,13 @@
<tr>
<td><code>app: <a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code></td>
<td>
- <p>- The <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> instance that the returned <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance is associated with.</p>
+ <p>The <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code> instance that the returned <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance is associated with.</p>
</td>
</tr>
<tr>
<td><code>database: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
<td>
- <p>- The name of database.</p>
+ <p>The database ID.</p>
</td>
</tr>
</tbody> |
Coverage Report 1Affected Products
Test Logs |
Unit Test Results 162 files + 108 162 suites +108 2m 20s ⏱️ - 4m 45s Results for commit b5d65ba. ± Comparison against base commit 4d1cc39. This pull request removes 470 and adds 1164 tests. Note that renamed tests count towards both.♻️ This comment has been updated with latest results. |
Size Report 1Affected ProductsNo changes between base commit (4d1cc39) and merge commit (64ef2fc).Test Logs |
Startup Time Report 1Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS. Notes
Startup Times
|
markarndt
approved these changes
Jul 14, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is to address comment in cl/545750836.