-
Notifications
You must be signed in to change notification settings - Fork 41.4k
Polish #14667
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
Polish #14667
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks again for the PR. I am not sure about one change so I've added a question.
"description": "Minimum \"Content-Length\" value that is required for compression to be performed.", | ||
"type": "org.springframework.util.unit.DataSize", | ||
"defaultValue": "2KB" | ||
}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you share a bit more context why this got removed? I am afraid I had to add it because Compression
is in spring-boot
and the annotation processor can't read the source description on it.
If you've missed that, you're raising a red flag anyway as we should probably document all properties consistently.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@snicoll Thanks for the feedback! I just expected that comments on fields in Compression
will be harvested for the configuration metadata by the annotation processor. Do I have a wrong expectation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do I have a wrong expectation?
You don't but, unfortunately, it doesn't work that way at the moment.
Compression
is in the spring-boot
module and it is being used in the spring-boot-autoconfigure
module. When the annotation processor runs, it doesn't have access to the source model of Compression
(as it's not being compiled in that round). I can see one way to fix that by adding the sources of spring-boot
when compiling spring-boot-auto-configure
.
In any case, let's raise a separate issue for this and we can take it from there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Yes, let's figure this out in #14669 (as manually documenting them may be the outcome of that issue).
* pr/14667: Polish contribution Polish
This PR fixes some typos and polishes trivial stuff.