docs: catch actual exception in java doc comment by suraj-qlogic · Pull Request #312 · googleapis/java-storage

suraj-qlogic · 2020-05-12T16:36:34Z

Fixes #309

codecov · 2020-05-12T16:43:19Z

Codecov Report

Merging #312 into master will increase coverage by 0.13%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master     #312      +/-   ##
============================================
+ Coverage     62.49%   62.62%   +0.13%     
- Complexity      552      553       +1     
============================================
  Files            31       31              
  Lines          5007     5022      +15     
  Branches        449      480      +31     
============================================
+ Hits           3129     3145      +16     
- Misses         1709     1711       +2     
+ Partials        169      166       -3

Impacted Files	Coverage Δ	Complexity Δ
...e/src/main/java/com/google/cloud/storage/Blob.java	`82.08% <ø> (+0.10%)`	`30.00 <0.00> (+1.00)`
...rc/main/java/com/google/cloud/storage/Storage.java	`80.90% <ø> (ø)`	`0.00 <0.00> (ø)`
...om/google/cloud/storage/spi/v1/HttpStorageRpc.java	`1.52% <0.00%> (-0.01%)`	`1.00% <0.00%> (ø%)`
...ain/java/com/google/cloud/storage/StorageImpl.java	`80.27% <0.00%> (+0.12%)`	`131.00% <0.00%> (ø%)`
...main/java/com/google/cloud/storage/BucketInfo.java	`81.04% <0.00%> (+0.19%)`	`84.00% <0.00%> (ø%)`
...gle/cloud/storage/testing/RemoteStorageHelper.java	`64.51% <0.00%> (+0.58%)`	`9.00% <0.00%> (ø%)`
...in/java/com/google/cloud/storage/StorageBatch.java	`92.00% <0.00%> (+4.00%)`	`13.00% <0.00%> (ø%)`

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 5566daf...f320ab8. Read the comment docs.

elharo · 2020-05-12T17:00:40Z

google-cloud-storage/src/main/java/com/google/cloud/storage/Blob.java

@@ -728,7 +728,7 @@ public ReadChannel reader(BlobSourceOption... options) {
   * try (WriteChannel writer = blob.writer()) {


no need for the nested try block, one will do here

elharo · 2020-05-12T17:00:57Z

google-cloud-storage/src/main/java/com/google/cloud/storage/Storage.java

@@ -2505,7 +2505,7 @@ Blob create(
   * try (WriteChannel writer = storage.writer(blobInfo)) {


don't nest the try block, one is enough

frankyn

1 nit, thank you for sending this @suraj-qlogic!

frankyn · 2020-05-12T18:46:54Z

google-cloud-storage/src/main/java/com/google/cloud/storage/Blob.java

-   *   try {
   *     writer.write(ByteBuffer.wrap(content, 0, content.length));
-   *   } catch (Exception ex) {
+   *   } catch (IOException ex) {


The end } isn't aligned with the opening try(). Please fix the spacing. This should be done below as well.

elharo · 2020-05-13T12:51:54Z

google-cloud-storage/src/main/java/com/google/cloud/storage/Blob.java

+   * } catch (IOException ex) {
+   *   // handle exception
   * }
   * }</pre>


you still have an extra closing brace

@elharo ,I have gone throught code and found there is no extra closing brace.Here last closing brace indicate closing of {@code } tag.Can you please look once?

line 733, just before , same below

@elharo

* <pre>{@code * byte[] content = "Hello, World!".getBytes(UTF_8); * try (WriteChannel writer = blob.writer()) { * writer.write(ByteBuffer.wrap(content, 0, content.length)); * } catch (IOException ex) { * // handle exception * } * }</pre>

Here First closing } brace indicate closing of try block,Second } brace indicate closing
for catch clause.and last one } indicate closing of <pre>{@code so can we write document comment without ending <pre>{@code?

By my count you have two open braces and three close braces. Change line 733 from

}</pre> to </pre>

elharo · 2020-05-13T12:52:07Z

google-cloud-storage/src/main/java/com/google/cloud/storage/Storage.java

+   * } catch (IOException ex) {
+   *   // handle exception
   * }
   * }</pre>


extra close brace

Same as above.

frankyn · 2020-05-13T16:52:24Z

google-cloud-storage/src/main/java/com/google/cloud/storage/Blob.java

+   *   // handle exception
   * }
-   * }</pre>
+   * </pre>


You do need this }</pre> closing bracket to close {@code... } on line 726

@elharo

frankyn

LGTM

docs: catch actual exception in java doc comment

47dcb7f

googlebot added the cla: yes This human has signed the Contributor License Agreement. label May 12, 2020

suraj-qlogic requested a review from elharo May 12, 2020 16:36

elharo reviewed May 12, 2020

View reviewed changes

athakor added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 12, 2020

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label May 12, 2020

docs: fix review changes

16cf135

suraj-qlogic requested a review from elharo May 12, 2020 17:53

frankyn suggested changes May 12, 2020

View reviewed changes

docs: fix review changes

bed6047

suraj-qlogic requested a review from frankyn May 13, 2020 05:04

elharo reviewed May 13, 2020

View reviewed changes

suraj-qlogic requested a review from elharo May 13, 2020 13:43

docs: fix review changes

7db165e

elharo approved these changes May 13, 2020

View reviewed changes

frankyn suggested changes May 13, 2020

View reviewed changes

docs: fix review changes

f320ab8

frankyn approved these changes May 13, 2020

View reviewed changes

frankyn added the automerge Merge the pull request once unit tests and other checks pass. label May 13, 2020

gcf-merge-on-green bot merged commit 9201de5 into googleapis:master May 13, 2020

suraj-qlogic deleted the storage-309 branch May 15, 2020 03:41

		@@ -728,7 +728,7 @@ public ReadChannel reader(BlobSourceOption... options) {
		* try (WriteChannel writer = blob.writer()) {

		@@ -2505,7 +2505,7 @@ Blob create(
		* try (WriteChannel writer = storage.writer(blobInfo)) {

Conversation

suraj-qlogic commented May 12, 2020

Uh oh!

codecov bot commented May 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frankyn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

suraj-qlogic May 13, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frankyn left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov bot commented May 12, 2020 •

edited

Loading

suraj-qlogic May 13, 2020 •

edited

Loading