Skip to content

Polish README - #450

Closed
scordio wants to merge 1 commit into
spring-io:mainfrom
scordio:patch-1
Closed

Polish README#450
scordio wants to merge 1 commit into
spring-io:mainfrom
scordio:patch-1

Conversation

@scordio

@scordio scordio commented Jun 21, 2025

Copy link
Copy Markdown
Contributor

I initially just wanted to fix the level of the Maven's Checkstyle section:

image

Eventually, I fixed some typos and made small adjustments that I think can improve README's readability 🙂

Of course, feel free to drop them if you don't like them!

Signed-off-by: Stefano Cordio <stefano.cordio@gmail.com>
Comment thread README.adoc
By default, tabs are used for indenting formatted code.
We strongly recommend that this default is not changed, especially for official Spring projects.
If, however, you feel that you can't live with tabs then switching to spaces is the one configuration option that we do support.
If, however, you feel that you can't live with tabs, then switching to spaces is the one configuration option that we do support.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A comma isn't needed with "then" so this should either be "… live with tabs then switching …" or "… live with tabs, switching". Given the style elsewhere, I think the latter's better. We can make that tweak as part of merging.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Oh yes, somehow I missed deleting the "then" in my proposal. Thanks for taking care of that!

@wilkinsona wilkinsona changed the title Fix Maven's Checkstyle section level, improve README readability Polish README Jun 23, 2025
@wilkinsona wilkinsona self-assigned this Jun 23, 2025
wilkinsona pushed a commit that referenced this pull request Jun 23, 2025
Signed-off-by: Stefano Cordio <stefano.cordio@gmail.com>

See gh-450
wilkinsona added a commit that referenced this pull request Jun 23, 2025
@wilkinsona

Copy link
Copy Markdown
Contributor

Thanks very much, @scordio.

@wilkinsona wilkinsona added this to the 0.0.48 milestone Jun 23, 2025
@scordio
scordio deleted the patch-1 branch June 23, 2025 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants