mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
Checkstyle: Catch wide snippets (#34163)
We use wrap code in `// tag` and `//end` to include it in our docs. Our current docs style wraps code snippets in a box that is only wide enough for 76 characters and adds a horizontal scroll bar for wider snippets which makes the snippet much harder to read. This adds a checkstyle check that looks for java code that is included in the docs and is wider than that 76 characters so all snippets fit into the box. It solves many of the failures that this catches but suppresses many more. I will clean those up in a follow up change.
This commit is contained in:
parent
2923fb5b31
commit
ad3218b4ab
7 changed files with 175 additions and 92 deletions
|
@ -1,3 +1,4 @@
|
|||
[[java-rest-low-config]]
|
||||
== Common configuration
|
||||
|
||||
As explained in <<java-rest-low-usage-initialization>>, the `RestClientBuilder`
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue