Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upFix missing description for configuration keys in generated appendix #21131
Labels
Milestone
Comments
|
FTR, that affects only |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
While discussing some documentation improvements (see #21077 and #21121), I've noticed that several common application properties have no description in the current docs dedicated section.
However, all these properties have the descriptive comment, as visible in version
2.1.xdocs which was using a different "template" for rendering documentation.Some properties in this situation are:
spring.info.git.locationspring.data.rest.detection-strategyspring.datasource.initialization-mode(see screenshots below)spring.elasticsearch.rest.urisspring.mongodb.embedded.featuresAfter a quick look at the 2.1.x doc page, it seems that all the properties have a comment from which the description should be obtained.
This should be further investigated (maybe also checking the
Default Valuefield too), but I have no clue on where to find the code which does this "description extraction". If someone can point me in the right direction, I'll try to have a look.spring.datasource.initialization-mode- Current docspring.datasource.initialization-mode- 2.1.x doc