Skip to content

Commit e234529

Browse files
wangzhenhui1992kcm
authored andcommitted
[Docs] Add explanation for code snippets line width (#34796)
Add "Line width for code snippets is 76 characters" to Java Language Formatting Guidelines
1 parent 9818272 commit e234529

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@ Please follow these formatting guidelines:
159159

160160
* Java indent is 4 spaces
161161
* Line width is 140 characters
162+
* Line width for code snippets that are included in the documentation (the ones surrounded by `// tag` and `// end` comments) is 76 characters
162163
* The rest is left to Java coding standards
163164
* Disable “auto-format on save” to prevent unnecessary format changes. This makes reviews much harder as it generates unnecessary formatting changes. If your IDE supports formatting only modified chunks that is fine to do.
164165
* Wildcard imports (`import foo.bar.baz.*`) are forbidden and will cause the build to fail. This can be done automatically by your IDE:

0 commit comments

Comments
 (0)