You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@bookkeeper.apache.org by GitBox <gi...@apache.org> on 2017/12/18 21:17:05 UTC

[GitHub] sijie closed pull request #872: add try-with-resources in coding_guide

sijie closed pull request #872: add try-with-resources in coding_guide
URL: https://github.com/apache/bookkeeper/pull/872
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/site/community/coding_guide.md b/site/community/coding_guide.md
index 3033fa0d0..371f13cc0 100644
--- a/site/community/coding_guide.md
+++ b/site/community/coding_guide.md
@@ -10,10 +10,11 @@ Please refer to our [checkstyle rules](https://github.com/apache/bookkeeper/blob
 
 Apache BookKeeper code should follow the [Sun Java Coding Convention](http://www.oracle.com/technetwork/java/javase/documentation/codeconvtoc-136057.html), with the following additions.
 
-* Lines can be up to 120 characters long.
+* Lines can not be longer than 120 characters.
 * Indentation should be **4 spaces**. Tabs should never be used.
 * Use curly braces even for single-line ifs and elses.
-* No @author tags in any javadoc
+* No @author tags in any javadoc.
+* Use try-with-resources blocks whenever is possible.
 * **TODO**s should be associated to at least one issue. E.g. `// TODO: make this parameter configurable (https://github.com/apache/bookkeeper/issues/280)`
 
 ### Dependencies


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services