This is an automated email from the ASF dual-hosted git repository.
sijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/master by this push:
new 5199fad add try-with-resources in coding_guide
5199fad is described below
commit 5199fad8afb49276372f71f49810e7565761cafd
Author: Jia Zhai <[email protected]>
AuthorDate: Mon Dec 18 13:16:50 2017 -0800
add try-with-resources in coding_guide
Descriptions of the changes in this PR:
This is related to PR #845, and want to add try-with-resources in
coding_guide.
Author: Jia Zhai <[email protected]>
Reviewers: Enrico Olivelli <[email protected]>, Sijie Guo
<[email protected]>
This closes #872 from jiazhai/fix_doc
---
site/community/coding_guide.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/site/community/coding_guide.md b/site/community/coding_guide.md
index 3033fa0..371f13c 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
--
To stop receiving notification emails like this one, please contact
['"[email protected]" <[email protected]>'].
