Supplementary explanation for code snippets line width #34796
Conversation
Add "Line width for code snippets is 76 characters" to Java Language Formatting Guidelines
There was a problem hiding this comment.
Hi @wangzhenhui1992,
thanks for opening the issue and this PR. I agree it would be helpful to document the line length restrictions for code snippets somewhere. I think doing this here in CONTRIBUTING.md is a good start, but I want to suggest adding a little bit of context since the 76 character limit is only necessary for code snippets that are included in the documentation (the ones surrounded by // tag and // end comments). While this might be clear to somebody who has already written these code snippets, it might be confusing to people just working in the regular code base. I would suggest adding a short additional sentence for clarification, without going to much into detail.
|
@cbuescher |
|
Pinging @elastic/es-docs |
code snipptes that are included in the documentation (the ones surrounded by `// tag` and `// end` comments)
|
@cbuescher I have added the additional sentence and review please. |
There was a problem hiding this comment.
Thanks @wangzhenhui1992, this looks good to me now. I will merge to master and the latest release branch.
Add "Line width for code snippets is 76 characters" to Java Language Formatting Guidelines
* master: (74 commits) XContent: Check for bad parsers (elastic#34561) Docs: Align prose with snippet (elastic#34839) document the search context is freed if the scroll is not extended (elastic#34739) Test: Lookup node versions on rest test start (elastic#34657) SQL: Return error with ORDER BY on non-grouped. (elastic#34855) Reduce channels in AbstractSimpleTransportTestCase (elastic#34863) [DOCS] Updates Elasticsearch monitoring tasks (elastic#34339) Check self references in metric agg after last doc collection (elastic#33593) (elastic#34001) [Docs] Add `indices.query.bool.max_clause_count` setting (elastic#34779) Add 6.6.0 version to master (elastic#34847) Test: ensure char[] doesn't being with prefix (elastic#34816) Remove static import from HLRC doc snippet (elastic#34834) Logging: server: clean up logging (elastic#34593) Logging: tests: clean up logging (elastic#34606) SQL: Fix edge case: `<field> IN (null)` (elastic#34802) [Test] Mute FullClusterRestartIT.testShrink() until test is fixed SQL: Introduce ODBC mode, similar to JDBC (elastic#34825) SQL: handle X-Pack or X-Pack SQL not being available in a more graceful way (elastic#34736) [Docs] Add explanation for code snippets line width (elastic#34796) CCR: Rename follow-task parameters and stats (elastic#34836) ...
Add "Line width for code snippets is 76 characters" to Java Language Formatting Guidelines
Add "Line width for code snippets is 76 characters" to Java Language Formatting Guidelines
For issue #34795