docs: improve description for whitespace checks #18285
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation by replacing a generic placeholder description with a more informative explanation of the Whitespace Checks functionality.
- Replaces the repetitive "Whitespace Checks" text with a detailed description that explains the purpose and benefits of whitespace validation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <body> | ||
| <section name="Whitespace Checks"> | ||
| <p>Whitespace Checks</p> | ||
| <p>Whitespace Checks validate the correct usage of whitespace in Java code to improve readability and maintain coding standards.</p> |
There was a problem hiding this comment.
This change creates an inconsistency with other similar configuration files. All other config_*.xml files in the same directory (config_coding.xml, config_naming.xml, config_blocks.xml, config_design.xml, config_javadoc.xml, etc.) use a minimal description pattern where the paragraph simply repeats the section name. While this detailed description is an improvement in isolation, it would be better to either update all similar files together to maintain consistency, or keep the same pattern across all configuration landing pages.
| <p>Whitespace Checks validate the correct usage of whitespace in Java code to improve readability and maintain coding standards.</p> | |
| <p>Whitespace Checks</p> |
PLEASE READ BEFORE REMOVING
Rules:
"approved"label.Example:
"Issue: #XXXXXX"MUST match any one of the following patterns:
MUST contain only one line of text
MUST NOT end with a period, space, or tab
MUST be less than or equal to 200 characters
To avoid multiple iterations of fixes and CI failures, please read
Contribution Guide.
ATTENTION: Pull Requests that do not pass our CI checks will not be merged,
but we will help to resolve issues.
Thanks for reading, feel free to remove this whole message and type what you need.