Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

correct out of date Java style guide #269

Merged
merged 1 commit into from
May 1, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions docs/java-style-guide/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,12 +221,6 @@ top-level class it contains, plus the `.java` extension.

Source files are encoded in **UTF-8**.

### File length: 2000 lines
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed in #85


(not in [Google Java Style Guide](https://github.com/google/styleguide))

Source files contain at most 2000 lines.

### Special characters

#### Line ending: LF
Expand Down Expand Up @@ -332,10 +326,8 @@ Unused or redundant imports should be removed.

Static imports of project-specific methods limit readability as they
obfuscate method provenance. Static imports are thus discouraged with
the exception of folklore methods under `org.junit.Assert`,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

modified in #240

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: worth matching

java.util.Collections.*,
java.util.stream.Collectors.*,
, specifically java collector and collection?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

didn't want to have to update the docs every time we change that checkstyle rule -- but I guess we shouldn't be changing it so much after #240?

`org.hamcrest.Matchers`, `org.assertj.core.api.Assertions`,
`org.mockito.Mockito`, Guava `Preconditions`, and Apache Commons Lang3
`Validate`.
the exception of folklore methods such as Guava `Preconditions`, and
Apache Commons Lang3 `Validate`.

### Class declaration

Expand Down