Skip to content

Conversation

@schmidt-sebastian
Copy link
Contributor

These methods are deprecated as per the JavaDoc but we should probably use an Annotation as well.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jul 29, 2019
@BenWhitehead
Copy link
Contributor

I'm okay with the additional detail, but the javadocs don't seem to provide an alternative of how the users is supposed to be able to do this sort of operation. Do you know what the replacement is that we could refer to?

@schmidt-sebastian
Copy link
Contributor Author

The JavaDoc's deprecated comments do say to use listCollections(). GitHub decided that is not worth showing :/ Is there something else we should be doing?

@BenWhitehead
Copy link
Contributor

Ah, so it does my mistake. LGTM.

@BenWhitehead
Copy link
Contributor

Actually, can we change the deprecation javadocs to use this format:

   * @deprecated Use {@link #listCollections()}.

Instead of the back-ticks. This will make the link clickable in the javadocs if we do it.

@schmidt-sebastian
Copy link
Contributor Author

Updated the JavaDoc to use the links as suggested.

@codecov
Copy link

codecov bot commented Jul 29, 2019

Codecov Report

Merging #5916 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master    #5916      +/-   ##
============================================
- Coverage     46.79%   46.79%   -0.01%     
- Complexity    25648    25663      +15     
============================================
  Files          2456     2456              
  Lines        267593   267593              
  Branches      30564    30559       -5     
============================================
- Hits         125229   125228       -1     
- Misses       133105   133106       +1     
  Partials       9259     9259
Impacted Files Coverage Δ Complexity Δ
.../com/google/cloud/firestore/DocumentReference.java 73.25% <ø> (ø) 31 <0> (ø) ⬇️
...ain/java/com/google/cloud/pubsub/v1/Publisher.java 89.54% <0%> (-0.35%) 40% <0%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b212217...26f2be6. Read the comment docs.

@schmidt-sebastian schmidt-sebastian merged commit 722b079 into master Jul 30, 2019
@Neenu1995 Neenu1995 deleted the mrschmidt/adddeprecated branch July 6, 2022 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants