Skip to content

Conversation

@rhamedy
Copy link
Contributor

@rhamedy rhamedy commented Oct 14, 2019

Added a note to the spring-boot-features.adoc to clarify that formatting
configuration property descriptions is not supported.

Fixes gh-18572

Added a note to the spring-boot-features.adoc to clarify that formatting
configuration property descriptions is not supported.

Fixes spring-projectsgh-18572
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Oct 14, 2019
@rhamedy
Copy link
Contributor Author

rhamedy commented Oct 14, 2019

Hi @philwebb
I added the NOTE suggested by @snicoll after the bullet point
Do not provide the default value in the description unless it has to be determined at runtime.
in the section suggested by @wilkinsona

Strangely enough, in my local environment (eclipse, using the provided installer) whenever I run ./mvnw clean install the nohttp-checkstyle-validation validation fails.

Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.0.0:check (nohttp-checkstyle-validation) on project spring-boot-build: You have 909 Checkstyle violations.

I wonder if I have to change some settings locally for the nohttp-checkstyle-validation. I have tested this PR's changes in an online tool https://asciidoclive.com and looks good 👍

@snicoll snicoll self-assigned this Oct 15, 2019
@snicoll snicoll added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Oct 15, 2019
@snicoll snicoll added this to the 2.1.10 milestone Oct 15, 2019
@snicoll snicoll changed the title Updated doc to clarify formatting configuration property descriptions is not supported Document formatting recommendations for configuration property javadoc Oct 15, 2019
snicoll pushed a commit that referenced this pull request Oct 15, 2019
This commit adds a note to spring-boot-features.adoc to clarify that
using javadoc tags to format configuration property descriptions is not
supported.

See gh-18578
snicoll added a commit that referenced this pull request Oct 15, 2019
@snicoll snicoll closed this in 34287fd Oct 15, 2019
@snicoll
Copy link
Member

snicoll commented Oct 15, 2019

Thanks again @rhamedy. I've polished your contribution to use a single line per sentence. I've also moved the note outside of the section that describes what we do as this should be done regardless you're interested in our conventions or not.

@rhamedy rhamedy deleted the gh-18572 branch October 16, 2019 02:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: documentation A documentation update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants