Skip to content

Fix doc format for multi-db #5139

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

Jump to bottom
Merged
merged 1 commit into from
Jul 6, 2023
Merged

Fix doc format for multi-db #5139

merged 1 commit into from
Jul 6, 2023

Conversation

wu-hui
Copy link
Contributor

@wu-hui wu-hui commented Jul 6, 2023

No description provided.

@wu-hui wu-hui requested a review from VinayGuthal July 6, 2023 14:20
@github-actions
Copy link
Contributor

github-actions bot commented Jul 6, 2023 •
edited
Loading

Javadoc Changes: 
--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/FirebaseFirestore.html	2023-07-06 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/FirebaseFirestore.html	2023-07-06 14:28:15.000000000 +0000
@@ -114,28 +114,28 @@
             <td><code>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></code></td>
             <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html#getInstance()">getInstance</a>()</code></div>
-              <p>Returns the default <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance associated with the default .</p>
+              <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>
             </td>
           </tr>
           <tr>
             <td><code>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></code></td>
             <td>
               <div><code><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>&nbsp;app)</code></div>
-              <p>Returns the default <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance that is associated with the provided <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>.</p>
+              <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>
             </td>
           </tr>
           <tr>
             <td><code>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></code></td>
             <td>
               <div><code><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>&nbsp;database)</code></div>
-              <p>Returns the <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance that is associated with the default .</p>
+              <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>
             </td>
           </tr>
           <tr>
             <td><code>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></code></td>
             <td>
               <div><code><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>&nbsp;app,&nbsp;@<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>&nbsp;database)</code></div>
-              <p>Returns the <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance that is associated with the provided .</p>
+              <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>
             </td>
           </tr>
           <tr>
@@ -651,13 +651,15 @@
       <div class="api-item"><a name="getInstance--"></a><a name="getinstance"></a>
         <h3 class="api-name" id="getInstance()">getInstance</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;@<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>&nbsp;<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 associated with the default . Returns the same instance for all invocations. If no instance exists, initializes a new instance with default settings.</p>
+        <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>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&nbsp;static&nbsp;@<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>&nbsp;<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>&nbsp;app)</pre>
-        <p>Returns the default <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance that is associated with the provided <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>. 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>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>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">
@@ -684,7 +686,8 @@
       <div class="api-item"><a name="getInstance-java.lang.String-"></a><a name="getinstance"></a>
         <h3 class="api-name" id="getInstance(java.lang.String)">getInstance</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;@<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>&nbsp;<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>&nbsp;database)</pre>
-        <p>Returns the <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance that is associated with the default . 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 <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>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">
@@ -711,7 +714,8 @@
       <div class="api-item"><a name="getInstance(com.google.firebase.FirebaseApp, java.lang.String)"></a><a name="getInstance-com.google.firebase.FirebaseApp-java.lang.String-"></a><a name="getinstance"></a>
         <h3 class="api-name" id="getInstance(com.google.firebase.FirebaseApp,java.lang.String)">getInstance</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;@<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>&nbsp;<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>&nbsp;app,&nbsp;@<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>&nbsp;database)</pre>
-        <p>Returns the <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance that is associated with the provided . 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 <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>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">
--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FirebaseFirestore.html	2023-07-06 14:33:06.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FirebaseFirestore.html	2023-07-06 14:28:15.000000000 +0000
@@ -114,28 +114,28 @@
             <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code></td>
             <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance()">getInstance</a>()</code></div>
-              <p>Returns the default <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance associated with the default .</p>
+              <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>
             </td>
           </tr>
           <tr>
             <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code></td>
             <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(com.google.firebase.FirebaseApp)">getInstance</a>(app:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a>)</code></div>
-              <p>Returns the default <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance that is associated with the provided <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>.</p>
+              <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>
             </td>
           </tr>
           <tr>
             <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code></td>
             <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(java.lang.String)">getInstance</a>(database:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
-              <p>Returns the <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance that is associated with the default .</p>
+              <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>
             </td>
           </tr>
           <tr>
             <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code></td>
             <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(com.google.firebase.FirebaseApp,java.lang.String)">getInstance</a>(app:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a>,&nbsp;database:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
-              <p>Returns the <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html">FirebaseFirestore</a></code> instance that is associated with the provided .</p>
+              <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>
             </td>
           </tr>
           <tr>
@@ -651,13 +651,15 @@
       <div class="api-item"><a name="getInstance--"></a><a name="getinstance"></a>
         <h3 class="api-name" id="getInstance()">getInstance</h3>
         <pre class="api-signature no-pretty-print">java-static&nbsp;fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance()">getInstance</a>():&nbsp;<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 associated with the default . Returns the same instance for all invocations. If no instance exists, initializes a new instance with default settings.</p>
+        <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>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&nbsp;fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(com.google.firebase.FirebaseApp)">getInstance</a>(app:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a>):&nbsp;<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 that is associated with the provided <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a></code>. 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>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>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">
@@ -684,7 +686,8 @@
       <div class="api-item"><a name="getInstance-java.lang.String-"></a><a name="getinstance"></a>
         <h3 class="api-name" id="getInstance(java.lang.String)">getInstance</h3>
         <pre class="api-signature no-pretty-print">java-static&nbsp;fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(java.lang.String)">getInstance</a>(database:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>):&nbsp;<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 that is associated with the default . 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 <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>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">
@@ -711,7 +714,8 @@
       <div class="api-item"><a name="getInstance(com.google.firebase.FirebaseApp, java.lang.String)"></a><a name="getInstance-com.google.firebase.FirebaseApp-java.lang.String-"></a><a name="getinstance"></a>
         <h3 class="api-name" id="getInstance(com.google.firebase.FirebaseApp,java.lang.String)">getInstance</h3>
         <pre class="api-signature no-pretty-print">java-static&nbsp;fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#getInstance(com.google.firebase.FirebaseApp,java.lang.String)">getInstance</a>(app:&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html">FirebaseApp</a>,&nbsp;database:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>):&nbsp;<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 that is associated with the provided . 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 <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>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">

@google-oss-bot
Copy link
Contributor

1 Warning
⚠️ Did you forget to add a changelog entry? (Add the 'no-changelog' label to the PR to silence this warning.)

Generated by 🚫 Danger

@google-oss-bot
Copy link
Contributor

Coverage Report 1

Affected Products

  • firebase-firestore

    Overall coverage changed from 44.34% (e67be1e) to 44.32% (a6f0d7c) by -0.02%.

    FilenameBase (e67be1e)Merge (a6f0d7c)Diff
    LruGarbageCollector.java97.27%93.64%-3.64%

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/H8msMrcxyo.html

@github-actions
Copy link
Contributor

github-actions bot commented Jul 6, 2023

Unit Test Results

   162 files  +  34     162 suites  +34   2m 28s ⏱️ - 1m 5s
1 164 tests +136  1 148 ✔️ +120  16 💤 +16  0 ❌ ±0 
2 328 runs  +272  2 296 ✔️ +240  32 💤 +32  0 ❌ ±0 

Results for commit 8a24357. ± Comparison against base commit e67be1e.

@google-oss-bot
Copy link
Contributor

Size Report 1

Affected Products

  • firebase-firestore

    TypeBase (e67be1e)Merge (a6f0d7c)Diff
    aar1.36 MB1.36 MB+4 B (+0.0%)
    apk (release)3.95 MB3.95 MB+12 B (+0.0%)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/N519x43BoF.html

@wu-hui wu-hui merged commit fca527d into master Jul 6, 2023
@wu-hui wu-hui deleted the wuandy/FixDocFormat branch July 6, 2023 14:37
@google-oss-bot
Copy link
Contributor

Startup Time Report 1

Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS.

Notes

Startup Times

  • fire-fst

    DeviceStatisticsDistributions
    oriole-32
    Percentilee67be1ea6f0d7cDiffSignificant (?)
    p10333 ±29 μs315 ±13 μs-17.3 μs (-5.2%)NO
    p25352 ±35 μs327 ±18 μs-24.6 μs (-7.0%)NO
    p50386 ±53 μs345 ±27 μs-40.6 μs (-10.5%)NO
    p75446 ±80 μs404 ±81 μs-41.8 μs (-9.4%)NO
    p90537 ±121 μs490 ±147 μs-47.5 μs (-8.8%)NO

    20 test runs in comparison
    CommitTest Runs
    e67be1e
    • 2023-07-05_21:30:29.926632_BfdE
    • 2023-07-05_21:30:29.929060_JKfi
    • 2023-07-05_21:30:29.929072_KdOV
    • 2023-07-05_21:30:29.929079_TRpO
    • 2023-07-05_21:30:29.929085_JDuD
    • 2023-07-05_21:30:29.929640_ljsC
    • 2023-07-05_21:30:29.929648_BBQQ
    • 2023-07-05_21:30:29.929653_XzzY
    • 2023-07-05_21:30:29.929659_MacK
    • 2023-07-05_21:30:29.929664_muzC
    a6f0d7c
    • 2023-07-06_14:35:50.512734_AqVK
    • 2023-07-06_14:35:50.514982_Nozm
    • 2023-07-06_14:35:50.514993_oosV
    • 2023-07-06_14:35:50.514999_ogrr
    • 2023-07-06_14:35:50.515005_oizK
    • 2023-07-06_14:35:50.515010_NzNs
    • 2023-07-06_14:35:50.515137_HOxq
    • 2023-07-06_14:35:50.515144_Twjo
    • 2023-07-06_14:35:50.515149_QdDM
    • 2023-07-06_14:35:50.515154_UsfB
    redfin-30
    Percentilee67be1ea6f0d7cDiffSignificant (?)
    p10595 ±27 μs586 ±26 μs-8.83 μs (-1.5%)NO
    p25609 ±28 μs599 ±25 μs-10.4 μs (-1.7%)NO
    p50633 ±33 μs617 ±29 μs-15.2 μs (-2.4%)NO
    p75668 ±43 μs648 ±36 μs-19.8 μs (-3.0%)NO
    p90703 ±53 μs685 ±55 μs-18.0 μs (-2.6%)NO

    20 test runs in comparison
    CommitTest Runs
    e67be1e
    • 2023-07-05_21:30:29.926632_BfdE
    • 2023-07-05_21:30:29.929060_JKfi
    • 2023-07-05_21:30:29.929072_KdOV
    • 2023-07-05_21:30:29.929079_TRpO
    • 2023-07-05_21:30:29.929085_JDuD
    • 2023-07-05_21:30:29.929640_ljsC
    • 2023-07-05_21:30:29.929648_BBQQ
    • 2023-07-05_21:30:29.929653_XzzY
    • 2023-07-05_21:30:29.929659_MacK
    • 2023-07-05_21:30:29.929664_muzC
    a6f0d7c
    • 2023-07-06_14:35:50.512734_AqVK
    • 2023-07-06_14:35:50.514982_Nozm
    • 2023-07-06_14:35:50.514993_oosV
    • 2023-07-06_14:35:50.514999_ogrr
    • 2023-07-06_14:35:50.515005_oizK
    • 2023-07-06_14:35:50.515010_NzNs
    • 2023-07-06_14:35:50.515137_HOxq
    • 2023-07-06_14:35:50.515144_Twjo
    • 2023-07-06_14:35:50.515149_QdDM
    • 2023-07-06_14:35:50.515154_UsfB

  • timeToInitialDisplay

    DeviceStatisticsDistributions
    oriole-32
    Percentilee67be1ea6f0d7cDiffSignificant (?)
    p10204 ±8 ms204 ±3 ms-511 μs (-0.3%)NO
    p25211 ±8 ms211 ±2 ms-382 μs (-0.2%)NO
    p50219 ±9 ms219 ±2 ms-525 μs (-0.2%)NO
    p75228 ±13 ms228 ±4 ms-441 μs (-0.2%)NO
    p90240 ±23 ms241 ±8 ms+1.13 ms (+0.5%)NO

    20 test runs in comparison
    CommitTest Runs
    e67be1e
    • 2023-07-05_21:30:29.926632_BfdE
    • 2023-07-05_21:30:29.929060_JKfi
    • 2023-07-05_21:30:29.929072_KdOV
    • 2023-07-05_21:30:29.929079_TRpO
    • 2023-07-05_21:30:29.929085_JDuD
    • 2023-07-05_21:30:29.929640_ljsC
    • 2023-07-05_21:30:29.929648_BBQQ
    • 2023-07-05_21:30:29.929653_XzzY
    • 2023-07-05_21:30:29.929659_MacK
    • 2023-07-05_21:30:29.929664_muzC
    a6f0d7c
    • 2023-07-06_14:35:50.512734_AqVK
    • 2023-07-06_14:35:50.514982_Nozm
    • 2023-07-06_14:35:50.514993_oosV
    • 2023-07-06_14:35:50.514999_ogrr
    • 2023-07-06_14:35:50.515005_oizK
    • 2023-07-06_14:35:50.515010_NzNs
    • 2023-07-06_14:35:50.515137_HOxq
    • 2023-07-06_14:35:50.515144_Twjo
    • 2023-07-06_14:35:50.515149_QdDM
    • 2023-07-06_14:35:50.515154_UsfB
    redfin-30
    Percentilee67be1ea6f0d7cDiffSignificant (?)
    p10245 ±5 ms269 ±4 ms+24.6 ms (+10.1%)MAYBE
    p25251 ±6 ms276 ±4 ms+24.6 ms (+9.8%)MAYBE
    p50258 ±6 ms283 ±5 ms+25.2 ms (+9.7%)MAYBE
    p75267 ±7 ms295 ±6 ms+27.7 ms (+10.4%)MAYBE
    p90277 ±8 ms309 ±8 ms+31.7 ms (+11.4%)MAYBE

    20 test runs in comparison
    CommitTest Runs
    e67be1e
    • 2023-07-05_21:30:29.926632_BfdE
    • 2023-07-05_21:30:29.929060_JKfi
    • 2023-07-05_21:30:29.929072_KdOV
    • 2023-07-05_21:30:29.929079_TRpO
    • 2023-07-05_21:30:29.929085_JDuD
    • 2023-07-05_21:30:29.929640_ljsC
    • 2023-07-05_21:30:29.929648_BBQQ
    • 2023-07-05_21:30:29.929653_XzzY
    • 2023-07-05_21:30:29.929659_MacK
    • 2023-07-05_21:30:29.929664_muzC
    a6f0d7c
    • 2023-07-06_14:35:50.512734_AqVK
    • 2023-07-06_14:35:50.514982_Nozm
    • 2023-07-06_14:35:50.514993_oosV
    • 2023-07-06_14:35:50.514999_ogrr
    • 2023-07-06_14:35:50.515005_oizK
    • 2023-07-06_14:35:50.515010_NzNs
    • 2023-07-06_14:35:50.515137_HOxq
    • 2023-07-06_14:35:50.515144_Twjo
    • 2023-07-06_14:35:50.515149_QdDM
    • 2023-07-06_14:35:50.515154_UsfB

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/T1ylwkRgk4/index.html

VinayGuthal pushed a commit that referenced this pull request Jul 6, 2023
@wu-hui @VinayGuthal
Fix doc format for multi-db (#5139)
2c7db53
@firebase firebase locked and limited conversation to collaborators Aug 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@VinayGuthal VinayGuthal VinayGuthal approved these changes

Assignees

@VinayGuthal VinayGuthal

Labels
size/S
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@wu-hui @google-oss-bot @VinayGuthal