search

firebase / firebase-android-sdk

Firebase Android SDK
https://firebase.google.com
Apache License 2.0
2.26k stars 572 forks source link

Address some documentation errors #6211

Closed wu-hui closed 1 month ago

github-actions[bot] commented 1 month ago
Javadoc Changes: ```diff --- /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 @@ @Nullable VectorValue
getVectorValue(@NonNull String field)
-

Returns the value of the field as a VectorValue or `null` if the field does not exist in the document.

+

Returns the value of the field as a VectorValue or null if the field does not exist in the document.

@@ -1865,7 +1865,7 @@

getVectorValue

public @Nullable VectorValue getVectorValue(@NonNull String field)
-

Returns the value of the field as a VectorValue or `null` if the field does not exist in the document.

+

Returns the value of the field as a VectorValue or null if the field does not exist in the document.

@@ -1923,7 +1923,7 @@ ``` ```diff --- /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 @@ ``` ```diff --- /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 @@ @@ -1827,7 +1827,7 @@

getVectorValue

fun getVectorValue(field: String): VectorValue?
-

Returns the value of the field as a VectorValue or `null` if the field does not exist in the document.

+

Returns the value of the field as a VectorValue or null if the field does not exist in the document.

java.lang.RuntimeException java.lang.RuntimeException -

if the value is not a VectorValue.

+

if the value is not a VectorValue.
@Nullable VectorValue -

Returns the value of the field as a VectorValue or `null` if the field does not exist in the document.

+

Returns the value of the field as a VectorValue or null if the field does not exist in the document.
VectorValue? -

Returns the value of the field as a VectorValue or `null` if the field does not exist in the document.

+

Returns the value of the field as a VectorValue or null if the field does not exist in the document.
@@ -1885,7 +1885,7 @@ ``` ```diff --- /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 @@ ```
google-oss-bot commented 1 month ago
java.lang.RuntimeException: java.lang.RuntimeException -

if the value is not a VectorValue.

+

if the value is not a VectorValue.
VectorValue? -

Returns the value of the field as a VectorValue or `null` if the field does not exist in the document.

+

Returns the value of the field as a VectorValue or null if the field does not exist in the document.
1 Warning
:warning: Did you forget to add a changelog entry? (Add the 'no-changelog' label to the PR to silence this warning.)

Generated by :no_entry_sign: Danger

google-oss-bot commented 1 month ago

<!DOCTYPE html>

Coverage Report 1

Affected Products

  • firebase-firestore

    Overall coverage changed from 46.06% (fd01196) to 46.05% (09212d4) by -0.02%.

    FilenameBase (fd01196)Merge (09212d4)Diff
    LruGarbageCollector.java97.27%93.64%-3.64%

Test Logs

google-oss-bot commented 1 month ago

<!DOCTYPE html>

Size Report 1

Affected Products

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

Test Logs

github-actions[bot] commented 1 month ago

Unit Test Results

   186 files   -    782     186 suites   - 782   4m 39s :stopwatch: - 30m 52s 1 234 tests  - 4 089  1 218 :heavy_check_mark:  - 4 084  16 :zzz:  -   5  0 :x: ±0  2 492 runs   - 8 239  2 460 :heavy_check_mark:  - 8 229  32 :zzz:  - 10  0 :x: ±0 

Results for commit f295324e. ± Comparison against base commit fd01196d.

google-oss-bot commented 1 month ago

<!DOCTYPE html>

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
    Percentilefd0119609212d4DiffSignificant (?)
    p10324 ±28 μs318 ±13 μs-5.54 μs (-1.7%)NO
    p25340 ±36 μs330 ±16 μs-9.59 μs (-2.8%)NO
    p50369 ±58 μs354 ±32 μs-15.8 μs (-4.3%)NO
    p75408 ±87 μs422 ±90 μs+14.0 μs (+3.4%)NO
    p90476 ±140 μs507 ±128 μs+31.3 μs (+6.6%)NO

    20 test runs in comparison
    CommitTest 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
    Percentilefd0119609212d4DiffSignificant (?)
    p10625 ±37 μs604 ±29 μs-20.8 μs (-3.3%)NO
    p25645 ±46 μs622 ±35 μs-23.0 μs (-3.6%)NO
    p50673 ±54 μs647 ±38 μs-25.5 μs (-3.8%)NO
    p75706 ±59 μs683 ±46 μs-23.2 μs (-3.3%)NO
    p90748 ±70 μs732 ±80 μs-15.9 μs (-2.1%)NO

    20 test runs in comparison
    CommitTest 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

    DeviceStatisticsDistributions
    oriole-32
    Percentilefd0119609212d4DiffSignificant (?)
    p10208 ±8 ms206 ±3 ms-1.15 ms (-0.6%)NO
    p25214 ±9 ms213 ±4 ms-718 μs (-0.3%)NO
    p50222 ±14 ms220 ±4 ms-1.47 ms (-0.7%)NO
    p75232 ±21 ms229 ±4 ms-2.91 ms (-1.3%)NO
    p90242 ±26 ms239 ±5 ms-3.35 ms (-1.4%)NO

    20 test runs in comparison
    CommitTest 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
    Percentilefd0119609212d4DiffSignificant (?)
    p10247 ±5 ms267 ±7 ms+20.4 ms (+8.3%)MAYBE
    p25253 ±6 ms274 ±9 ms+21.0 ms (+8.3%)NO
    p50261 ±8 ms283 ±13 ms+22.1 ms (+8.5%)NO
    p75269 ±9 ms293 ±16 ms+23.3 ms (+8.6%)NO
    p90279 ±8 ms308 ±22 ms+28.6 ms (+10.3%)NO

    20 test runs in comparison
    CommitTest 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

  • © Githubissues.
  • Githubissues is a development platform for aggregating issues.