Address some documentation errors #6211

wu-hui · 2024-08-23T17:57:15Z

No description provided.

github-actions · 2024-08-23T17:57:28Z

Javadoc Changes:

--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/DocumentSnapshot.html	2024-08-23 18:13:21.007239140 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/DocumentSnapshot.html	2024-08-23 18:10:50.712559782 +0000
@@ -287,7 +287,7 @@
             <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code></td>
             <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</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;field)</code></div>
-              <p>Returns the value of the field as a <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</p>
+              <p>Returns the value of the field as a <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or <code>null</code> if the field does not exist in the document.</p>
             </td>
           </tr>
           <tr>
@@ -1865,7 +1865,7 @@
       <div class="api-item"><a name="getVectorValue-java.lang.String-"></a><a name="getvectorvalue"></a>
         <h3 class="api-name" id="getVectorValue(java.lang.String)">getVectorValue</h3>
         <pre class="api-signature no-pretty-print">public&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a>&nbsp;<a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</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;field)</pre>
-        <p>Returns the value of the field as a <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</p>
+        <p>Returns the value of the field as a <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or <code>null</code> if the field does not exist in the document.</p>
         <div class="devsite-table-wrapper">
           <table class="responsive">
             <colgroup>
@@ -1923,7 +1923,7 @@
               <tr>
                 <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/RuntimeException.html">java.lang.RuntimeException</a>&nbsp;java.lang.RuntimeException</code></td>
                 <td>
-                  <p>if the value is not a VectorValue.</p>
+                  <p>if the value is not a <code>VectorValue</code>.</p>
                 </td>
               </tr>
             </tbody>

--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/QueryDocumentSnapshot.html	2024-08-23 18:13:21.007239140 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/QueryDocumentSnapshot.html	2024-08-23 18:10:50.708559710 +0000
@@ -349,7 +349,7 @@
                       <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code></td>
                       <td>
                         <div><code><a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</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;field)</code></div>
-                        <p>Returns the value of the field as a <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</p>
+                        <p>Returns the value of the field as a <code><a href="/docs/reference/android/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or <code>null</code> if the field does not exist in the document.</p>
                       </td>
                     </tr>
                     <tr>

--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/DocumentSnapshot.html	2024-08-23 18:13:20.947238080 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/DocumentSnapshot.html	2024-08-23 18:10:50.628558268 +0000
@@ -260,7 +260,7 @@
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a>?</code></td>
             <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</a>(field:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
-              <p>Returns the value of the field as a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</p>
+              <p>Returns the value of the field as a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or <code>null</code> if the field does not exist in the document.</p>
             </td>
           </tr>
           <tr>
@@ -1827,7 +1827,7 @@
       <div class="api-item"><a name="getVectorValue-java.lang.String-"></a><a name="getvectorvalue"></a>
         <h3 class="api-name" id="getVectorValue(java.lang.String)">getVectorValue</h3>
         <pre class="api-signature no-pretty-print">fun&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</a>(field:&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/VectorValue.html">VectorValue</a>?</pre>
-        <p>Returns the value of the field as a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</p>
+        <p>Returns the value of the field as a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or <code>null</code> if the field does not exist in the document.</p>
         <div class="devsite-table-wrapper">
           <table class="responsive">
             <colgroup>
@@ -1885,7 +1885,7 @@
               <tr>
                 <td><code>java.lang.RuntimeException:&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/RuntimeException.html">java.lang.RuntimeException</a></code></td>
                 <td>
-                  <p>if the value is not a VectorValue.</p>
+                  <p>if the value is not a <code>VectorValue</code>.</p>
                 </td>
               </tr>
             </tbody>

--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/QueryDocumentSnapshot.html	2024-08-23 18:13:20.947238080 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/QueryDocumentSnapshot.html	2024-08-23 18:10:50.624558196 +0000
@@ -318,7 +318,7 @@
                       <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a>?</code></td>
                       <td>
                         <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html#getVectorValue(java.lang.String)">getVectorValue</a>(field:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
-                        <p>Returns the value of the field as a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or `null` if the field does not exist in the document.</p>
+                        <p>Returns the value of the field as a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/VectorValue.html">VectorValue</a></code> or <code>null</code> if the field does not exist in the document.</p>
                       </td>
                     </tr>
                     <tr>

google-oss-bot · 2024-08-23T17:57:54Z

	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 · 2024-08-23T18:03:22Z

Coverage Report ¹

Affected Products

firebase-firestore
Overall coverage changed from 46.06% (fd01196) to 46.05% (09212d4) by -0.02%.
Filename Base (fd01196) Merge (09212d4) Diff
LruGarbageCollector.java 97.27% 93.64% -3.64%

Test Logs

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

google-oss-bot · 2024-08-23T18:06:38Z

Size Report ¹

Affected Products

No changes between base commit (fd01196) and merge commit (09212d4).

Test Logs

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

github-actions · 2024-08-23T18:13:45Z

Unit Test Results

  186 files -   782   186 suites - 782 4m 39s ⏱️ - 30m 52s
1 234 tests - 4 089 1 218 ✔️ - 4 084 16 💤 -   5 0 ❌ ±0
2 492 runs - 8 239 2 460 ✔️ - 8 229 32 💤 - 10 0 ❌ ±0

Results for commit f295324. ± Comparison against base commit fd01196.

google-oss-bot · 2024-08-23T18:33:49Z

Startup Time Report ¹

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

Notes

This report is for comparing the base commit (fd01196) and the CI merge commit (09212d4)
Please check below reports for each individual commit to find more details (Perfetto traces, histograms, detailed measurements)
- fd01196: https://storage.googleapis.com/firebase-sdk-metric-reports/Bm4Dn9yY1e/index.html
- 09212d4: https://storage.googleapis.com/firebase-sdk-metric-reports/OtmX2EijcT/index.html

Startup Times

`fire-fst`

Device Statistics Distributions

oriole-32

Percentile	`fd01196`	`09212d4`	Diff	Significant (?)
p10	324 ±28 μs	318 ±13 μs	-5.54 μs (-1.7%)	NO
p25	340 ±36 μs	330 ±16 μs	-9.59 μs (-2.8%)	NO
p50	369 ±58 μs	354 ±32 μs	-15.8 μs (-4.3%)	NO
p75	408 ±87 μs	422 ±90 μs	+14.0 μs (+3.4%)	NO
p90	476 ±140 μs	507 ±128 μs	+31.3 μs (+6.6%)	NO

20 test runs in comparison

Commit	Test Runs
`fd01196`	2024-08-23_16:34:48.906087_ROLN 2024-08-23_16:34:48.906128_mlIh 2024-08-23_16:34:48.906246_fzzz 2024-08-23_16:34:48.906261_wjYc 2024-08-23_16:34:48.906269_XcBl 2024-08-23_16:34:48.906277_olhd 2024-08-23_16:34:48.906284_hjEr 2024-08-23_16:34:48.906290_JLlM 2024-08-23_16:34:48.906297_arbv 2024-08-23_16:34:48.906309_Gezj
`09212d4`	2024-08-23_18:19:33.630824_yXpq 2024-08-23_18:19:33.630863_JWTf 2024-08-23_18:19:33.630874_THgE 2024-08-23_18:19:33.630881_VeAI 2024-08-23_18:19:33.630888_yWcX 2024-08-23_18:19:33.630895_CXBx 2024-08-23_18:19:33.630902_taac 2024-08-23_18:19:33.630908_bQhi 2024-08-23_18:19:33.630915_bRoH 2024-08-23_18:19:33.630922_cTOu

redfin-30

Percentile	`fd01196`	`09212d4`	Diff	Significant (?)
p10	625 ±37 μs	604 ±29 μs	-20.8 μs (-3.3%)	NO
p25	645 ±46 μs	622 ±35 μs	-23.0 μs (-3.6%)	NO
p50	673 ±54 μs	647 ±38 μs	-25.5 μs (-3.8%)	NO
p75	706 ±59 μs	683 ±46 μs	-23.2 μs (-3.3%)	NO
p90	748 ±70 μs	732 ±80 μs	-15.9 μs (-2.1%)	NO

20 test runs in comparison

Commit	Test Runs
`fd01196`	2024-08-23_16:34:48.906087_ROLN 2024-08-23_16:34:48.906128_mlIh 2024-08-23_16:34:48.906246_fzzz 2024-08-23_16:34:48.906261_wjYc 2024-08-23_16:34:48.906269_XcBl 2024-08-23_16:34:48.906277_olhd 2024-08-23_16:34:48.906284_hjEr 2024-08-23_16:34:48.906290_JLlM 2024-08-23_16:34:48.906297_arbv 2024-08-23_16:34:48.906309_Gezj
`09212d4`	2024-08-23_18:19:33.630824_yXpq 2024-08-23_18:19:33.630863_JWTf 2024-08-23_18:19:33.630874_THgE 2024-08-23_18:19:33.630881_VeAI 2024-08-23_18:19:33.630888_yWcX 2024-08-23_18:19:33.630895_CXBx 2024-08-23_18:19:33.630902_taac 2024-08-23_18:19:33.630908_bQhi 2024-08-23_18:19:33.630915_bRoH 2024-08-23_18:19:33.630922_cTOu

`timeToInitialDisplay`

Device Statistics Distributions

oriole-32

Percentile	`fd01196`	`09212d4`	Diff	Significant (?)
p10	208 ±8 ms	206 ±3 ms	-1.15 ms (-0.6%)	NO
p25	214 ±9 ms	213 ±4 ms	-718 μs (-0.3%)	NO
p50	222 ±14 ms	220 ±4 ms	-1.47 ms (-0.7%)	NO
p75	232 ±21 ms	229 ±4 ms	-2.91 ms (-1.3%)	NO
p90	242 ±26 ms	239 ±5 ms	-3.35 ms (-1.4%)	NO

20 test runs in comparison

Commit	Test Runs
`fd01196`	2024-08-23_16:34:48.906087_ROLN 2024-08-23_16:34:48.906128_mlIh 2024-08-23_16:34:48.906246_fzzz 2024-08-23_16:34:48.906261_wjYc 2024-08-23_16:34:48.906269_XcBl 2024-08-23_16:34:48.906277_olhd 2024-08-23_16:34:48.906284_hjEr 2024-08-23_16:34:48.906290_JLlM 2024-08-23_16:34:48.906297_arbv 2024-08-23_16:34:48.906309_Gezj
`09212d4`	2024-08-23_18:19:33.630824_yXpq 2024-08-23_18:19:33.630863_JWTf 2024-08-23_18:19:33.630874_THgE 2024-08-23_18:19:33.630881_VeAI 2024-08-23_18:19:33.630888_yWcX 2024-08-23_18:19:33.630895_CXBx 2024-08-23_18:19:33.630902_taac 2024-08-23_18:19:33.630908_bQhi 2024-08-23_18:19:33.630915_bRoH 2024-08-23_18:19:33.630922_cTOu

redfin-30

Percentile	`fd01196`	`09212d4`	Diff	Significant (?)
p10	247 ±5 ms	267 ±7 ms	+20.4 ms (+8.3%)	MAYBE
p25	253 ±6 ms	274 ±9 ms	+21.0 ms (+8.3%)	NO
p50	261 ±8 ms	283 ±13 ms	+22.1 ms (+8.5%)	NO
p75	269 ±9 ms	293 ±16 ms	+23.3 ms (+8.6%)	NO
p90	279 ±8 ms	308 ±22 ms	+28.6 ms (+10.3%)	NO

20 test runs in comparison

Commit	Test Runs
`fd01196`	2024-08-23_16:34:48.906087_ROLN 2024-08-23_16:34:48.906128_mlIh 2024-08-23_16:34:48.906246_fzzz 2024-08-23_16:34:48.906261_wjYc 2024-08-23_16:34:48.906269_XcBl 2024-08-23_16:34:48.906277_olhd 2024-08-23_16:34:48.906284_hjEr 2024-08-23_16:34:48.906290_JLlM 2024-08-23_16:34:48.906297_arbv 2024-08-23_16:34:48.906309_Gezj
`09212d4`	2024-08-23_18:19:33.630824_yXpq 2024-08-23_18:19:33.630863_JWTf 2024-08-23_18:19:33.630874_THgE 2024-08-23_18:19:33.630881_VeAI 2024-08-23_18:19:33.630888_yWcX 2024-08-23_18:19:33.630895_CXBx 2024-08-23_18:19:33.630902_taac 2024-08-23_18:19:33.630908_bQhi 2024-08-23_18:19:33.630915_bRoH 2024-08-23_18:19:33.630922_cTOu

https://storage.googleapis.com/firebase-sdk-metric-reports/9TcvUC6wGK/index.html

Address some documentation errors

e2096da

google-oss-bot added the size/XS label Aug 23, 2024

Merge branch 'main' into wuandy/DocumentationFix

f295324

wu-hui requested a review from davidmotson August 23, 2024 19:41

wu-hui assigned davidmotson Aug 23, 2024

davidmotson approved these changes Aug 23, 2024

View reviewed changes

wu-hui merged commit f4e5bd0 into main Aug 23, 2024
32 checks passed

wu-hui deleted the wuandy/DocumentationFix branch August 23, 2024 20:06

firebase locked and limited conversation to collaborators Sep 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Address some documentation errors #6211

Address some documentation errors #6211

Uh oh!

wu-hui commented Aug 23, 2024

Uh oh!

github-actions bot commented Aug 23, 2024 •

edited

Loading

Uh oh!

google-oss-bot commented Aug 23, 2024

Uh oh!

google-oss-bot commented Aug 23, 2024 •

edited

Loading

`firebase-firestore`

Uh oh!

google-oss-bot commented Aug 23, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Aug 23, 2024

Uh oh!

google-oss-bot commented Aug 23, 2024

`fire-fst`

`timeToInitialDisplay`

Uh oh!

Uh oh!

Uh oh!

Address some documentation errors #6211

Address some documentation errors #6211

Uh oh!

Conversation

wu-hui commented Aug 23, 2024

Uh oh!

github-actions bot commented Aug 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

google-oss-bot commented Aug 23, 2024

Uh oh!

google-oss-bot commented Aug 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report 1

Affected Products

firebase-firestore

Test Logs

Uh oh!

google-oss-bot commented Aug 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report 1

Affected Products

Test Logs

Uh oh!

github-actions bot commented Aug 23, 2024

Unit Test Results

Uh oh!

google-oss-bot commented Aug 23, 2024

Startup Time Report 1

Notes

Startup Times

fire-fst

timeToInitialDisplay

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Aug 23, 2024 •

edited

Loading

google-oss-bot commented Aug 23, 2024 •

edited

Loading

Coverage Report ¹

`firebase-firestore`

google-oss-bot commented Aug 23, 2024 •

edited

Loading

Size Report ¹

Startup Time Report ¹

`fire-fst`

`timeToInitialDisplay`