Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move default value descriptions to "description" in logging property metadata #42848

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

izeye
Copy link
Contributor

@izeye izeye commented Oct 23, 2024

This PR moves default value descriptions to "description" properties in logging property metadata as it doesn't seem to be conventional.

Feel free to close this if it's intentional for some reason.

See gh-41933

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Oct 23, 2024
@wilkinsona
Copy link
Member

Thanks, @izeye, but this is intentional. The default value in the metadata is equivalent to the value to which a field is initialized in a @ConfigurationProperties class. As such, it shouldn't be descriptive. It should just be the actual default value. In this case, there isn't such a value so we have to add something to the description explaining the situation.

@wilkinsona wilkinsona added status: declined A suggestion or change that we don't feel we should currently apply and removed status: waiting-for-triage An issue we've not yet triaged labels Oct 23, 2024
@wilkinsona wilkinsona closed this Oct 23, 2024
@izeye
Copy link
Contributor Author

izeye commented Oct 23, 2024

@wilkinsona Thanks for the feedback!

In this case, there isn't such a value so we have to add something to the description explaining the situation.

I'm a bit confused with this as it sounds like the description is added to the description property, not the defaultValue property.

You mean "the defaultValue explaining the situation", not "the description explaining the situation", right?

@wilkinsona
Copy link
Member

Oh dear, I somehow managed to read the diff backwards. Thanks for persevering with me. My comment above is, in fact, an explanation of why your change is needed 😬.

@wilkinsona wilkinsona reopened this Oct 23, 2024
@wilkinsona wilkinsona removed the status: declined A suggestion or change that we don't feel we should currently apply label Oct 23, 2024
@wilkinsona wilkinsona added this to the 3.2.x milestone Oct 23, 2024
@wilkinsona wilkinsona added the type: documentation A documentation update label Oct 23, 2024
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