docs: catch actual exception in java doc comment - #312
Conversation
Sorry, something went wrong.
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
Sorry, something went wrong.
| @@ -728,7 +728,7 @@ public ReadChannel reader(BlobSourceOption... options) { | |||
| * try (WriteChannel writer = blob.writer()) { | |||
There was a problem hiding this comment.
no need for the nested try block, one will do here
Sorry, something went wrong.
There was a problem hiding this comment.
Done
Sorry, something went wrong.
| @@ -2505,7 +2505,7 @@ Blob create( | |||
| * try (WriteChannel writer = storage.writer(blobInfo)) { | |||
There was a problem hiding this comment.
don't nest the try block, one is enough
Sorry, something went wrong.
There was a problem hiding this comment.
Done
Sorry, something went wrong.
frankyn
left a comment
There was a problem hiding this comment.
1 nit, thank you for sending this @suraj-qlogic!
Sorry, something went wrong.
| * try { | ||
| * writer.write(ByteBuffer.wrap(content, 0, content.length)); | ||
| * } catch (Exception ex) { | ||
| * } catch (IOException ex) { |
There was a problem hiding this comment.
The end } isn't aligned with the opening try(). Please fix the spacing. This should be done below as well.
Sorry, something went wrong.
There was a problem hiding this comment.
Done
Sorry, something went wrong.
| * } catch (IOException ex) { | ||
| * // handle exception | ||
| * } | ||
| * }</pre> |
There was a problem hiding this comment.
you still have an extra closing brace
Sorry, something went wrong.
Sorry, something went wrong.
There was a problem hiding this comment.
line 733, just before , same below
Sorry, something went wrong.
There was a problem hiding this comment.
* <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?
Sorry, something went wrong.
There was a problem hiding this comment.
By my count you have two open braces and three close braces. Change line 733 from
}</pre> to </pre>
Sorry, something went wrong.
There was a problem hiding this comment.
Done
Sorry, something went wrong.
| * } catch (IOException ex) { | ||
| * // handle exception | ||
| * } | ||
| * }</pre> |
There was a problem hiding this comment.
extra close brace
Sorry, something went wrong.
There was a problem hiding this comment.
Same as above.
Sorry, something went wrong.
| * // handle exception | ||
| * } | ||
| * }</pre> | ||
| * </pre> |
There was a problem hiding this comment.
You do need this }</pre> closing bracket to close {@code... } on line 726
Sorry, something went wrong.
There was a problem hiding this comment.
Done
Sorry, something went wrong.
frankyn
left a comment
There was a problem hiding this comment.
LGTM
Sorry, something went wrong.
🤖 I have created a release \*beep\* \*boop\* --- ## [1.109.0](https://www.github.com/googleapis/java-storage/compare/v1.108.0...v1.109.0) (2020-06-11) ### Features * adopt flatten-maven-plugin and java-shared-dependencies ([#325](https://www.github.com/googleapis/java-storage/issues/325)) ([209cae3](https://www.github.com/googleapis/java-storage/commit/209cae322932a4f87729fe4c5176a4f11962cfae)) * stub implementation of StorageRpc for the sake of testing ([#351](https://www.github.com/googleapis/java-storage/issues/351)) ([dd58025](https://www.github.com/googleapis/java-storage/commit/dd5802555eb0351a5afa2f2f197cb93ca6d3b66e)) ### Bug Fixes * blob.reload() does not work as intuitively expected ([#308](https://www.github.com/googleapis/java-storage/issues/308)) ([a2bab58](https://www.github.com/googleapis/java-storage/commit/a2bab58ccd89f48e8d4a8ee2dd776b201598420d)) ### Documentation * **fix:** update client documentation link ([#324](https://www.github.com/googleapis/java-storage/issues/324)) ([eb8940c](https://www.github.com/googleapis/java-storage/commit/eb8940cc6a88b5e2b3dea8d0ab2ffc1e350ab924)) * Add doc for equals method in blob ([#311](https://www.github.com/googleapis/java-storage/issues/311)) ([91fc36a](https://www.github.com/googleapis/java-storage/commit/91fc36a6673e30d1cfa8c4da51b874e1fd0b0535)) * catch actual exception in java doc comment ([#312](https://www.github.com/googleapis/java-storage/issues/312)) ([9201de5](https://www.github.com/googleapis/java-storage/commit/9201de559fe4218abd2e4fac47beac62454547cf)), closes [#309](https://www.github.com/googleapis/java-storage/issues/309) * update CONTRIBUTING.md to include code formatting ([#534](https://www.github.com/googleapis/java-storage/issues/534)) ([#315](https://www.github.com/googleapis/java-storage/issues/315)) ([466d08f](https://www.github.com/googleapis/java-storage/commit/466d08f9835a0f1dd00b5c9b3a08551be68d03ad)) * update readme to point client libarary documentation ([#317](https://www.github.com/googleapis/java-storage/issues/317)) ([8650f80](https://www.github.com/googleapis/java-storage/commit/8650f806736beec7bf7ab09a337b333bbf144f7b)) ### Dependencies * update dependency com.google.api.grpc:proto-google-common-protos to v1.18.0 ([#301](https://www.github.com/googleapis/java-storage/issues/301)) ([ff2dee2](https://www.github.com/googleapis/java-storage/commit/ff2dee2ce41d37787f0866ae740d3cd7f3b2bbd6)) * update dependency com.google.apis:google-api-services-storage to v1-rev20200410-1.30.9 ([#296](https://www.github.com/googleapis/java-storage/issues/296)) ([2e55aa2](https://www.github.com/googleapis/java-storage/commit/2e55aa2c8b9c78df9eebfe748fe72dcaae63ff81)) * update dependency com.google.apis:google-api-services-storage to v1-rev20200430-1.30.9 ([#319](https://www.github.com/googleapis/java-storage/issues/319)) ([3d03fa3](https://www.github.com/googleapis/java-storage/commit/3d03fa3381cfbb76d1501ec3d2ad14742a8a58dd)) * update dependency com.google.cloud:google-cloud-conformance-tests to v0.0.11 ([#320](https://www.github.com/googleapis/java-storage/issues/320)) ([6c18c88](https://www.github.com/googleapis/java-storage/commit/6c18c882cfe0c35b310a518e6044847e6fbeab94)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please).
Fixes #309