Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #18578 from rhamedy

Browse Source 
* pr/18578:
  Polish "Clarify formatting recommendations for configuration property javadoc"
  Clarify formatting recommendations for configuration property javadoc

Closes gh-18578
This commit is contained in:
Stephane Nicoll
2019-10-15 08:33:31 +02:00
parent f6d5f7777f f05d7902e2
commit 34287fd556
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
View File

@@ -7110,6 +7110,8 @@ Make sure that configuration keys are documented by adding field javadoc for eac
}
----
NOTE: You should only use simple text with `@ConfigurationProperties` field Javadoc, since they are not processed before being added to the JSON.
Here are some rules we follow internally to make sure descriptions are consistent:
* Do not start the description by "The" or "A".