Skip to content

Fix broken code links in comments of SetOptions.java #2162

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 3 commits into from
Nov 10, 2020
Merged

Fix broken code links in comments of SetOptions.java #2162

merged 3 commits into from
Nov 10, 2020

Conversation

wu-hui
Copy link
Contributor

@wu-hui wu-hui commented Nov 9, 2020

No description provided.

@wu-hui wu-hui requested a review from vkryachko November 9, 2020 19:22
@googlebot googlebot added the cla: yes Override cla label Nov 9, 2020
@google-oss-bot
Copy link
Contributor

google-oss-bot commented Nov 9, 2020 •
edited
Loading

Coverage Report

Affected SDKs

  • firebase-firestore

    SDK overall coverage changed from 46.83% (a9a6b9c) to 46.80% (e90c8661) by -0.03%.

    Filename Base (a9a6b9c) Head (e90c8661) Diff
    AbstractStream.java 34.52% 36.90% +2.38%
    GrpcCallProvider.java 68.18% 57.95% -10.23%

Test Logs

Notes

HTML coverage reports can be produced locally with ./gradlew <product>:checkCoverage.
Report files are located at <product-build-dir>/reports/jacoco/.

Head commit (e90c8661) is created by Prow via merging commits: a9a6b9c d4077de.

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Nov 9, 2020 •
edited
Loading

Binary Size Report

Affected SDKs

No changes between base commit (a9a6b9c) and head commit (e90c8661).

Test Logs

Notes

Head commit (e90c8661) is created by Prow via merging commits: a9a6b9c d4077de.

vkryachko
vkryachko reviewed Nov 9, 2020
View reviewed changes
Copy link
Member

@vkryachko vkryachko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SetOptions.java is not the only file mentioned in the bug, please make sure you fix the rest of the issues.

firebase-firestore/src/main/java/com/google/firebase/firestore/SetOptions.java Outdated
* the {@code set()} calls in {@link DocumentReference}, {@link WriteBatch} and {@link Transaction}
* can be configured to perform granular merges instead of overwriting the target documents in their
* entirety.
* SetOptions objects returned by {@link #merge()}, {@link #mergeFields(List<String>)} and {@link
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's valid syntax. it should be something like:

Suggested change
* SetOptions objects returned by {@link #merge()}, {@link #mergeFields(List<String>)} and {@link
* SetOptions objects returned by {@link #merge()}, {@link #mergeFields(List)} and {@link

i.e. without generic parameters.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

wu-hui
wu-hui commented Nov 10, 2020
View reviewed changes
Copy link
Contributor Author

@wu-hui wu-hui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original bug does not mention, but I think the other place is DocumentId.java?

firebase-firestore/src/main/java/com/google/firebase/firestore/SetOptions.java Outdated
* the {@code set()} calls in {@link DocumentReference}, {@link WriteBatch} and {@link Transaction}
* can be configured to perform granular merges instead of overwriting the target documents in their
* entirety.
* SetOptions objects returned by {@link #merge()}, {@link #mergeFields(List<String>)} and {@link
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

vkryachko
vkryachko approved these changes Nov 10, 2020
View reviewed changes
Copy link
Member

@vkryachko vkryachko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@google-oss-bot
Copy link
Contributor

@wu-hui: The following test failed, say /retest to rerun them all:

Test name Commit Details Rerun command
smoke-tests d4077de link /test smoke-tests

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@wu-hui wu-hui merged commit fd76164 into master Nov 10, 2020
@wu-hui wu-hui deleted the wuandy/FixCommentLinks branch December 10, 2020 02:25
@firebase firebase locked and limited conversation to collaborators Dec 11, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@vkryachko vkryachko vkryachko approved these changes

Assignees

@vkryachko vkryachko

Labels
cla: yes Override cla size/S
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@wu-hui @google-oss-bot @vkryachko @googlebot