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

Revise FilePatternResourceHintsRegistrar API and improve documentation #29161

Closed
sbrannen opened this issue Sep 15, 2022 · 7 comments
Closed
Assignees
Labels
in: core Issues in core modules (aop, beans, core, context, expression) theme: aot An issue related to Ahead-of-time processing type: documentation A documentation task
Milestone

Comments

@sbrannen
Copy link
Member

FilePatternResourceHintsRegistrar is not used anywhere in the Spring Framework code base, but it is used in Spring Boot.

We should consider moving FilePatternResourceHintsRegistrar to Spring Boot or improve the documentation to make it clear what use cases it's suited for.

@sbrannen sbrannen added type: task A general task theme: aot An issue related to Ahead-of-time processing labels Sep 15, 2022
@sbrannen sbrannen added this to the 6.0.0-RC1 milestone Sep 15, 2022
@snicoll
Copy link
Member

snicoll commented Sep 15, 2022

FilePatternResourceHintsRegistrar is not used anywhere in the Spring Framework code base,

I am not sure I understand that. Shouldn't we rather focus on whether this can be useful as a framework utility like plenty of others we don't use ourselves? I agree that the current code is a bit specific to one use case at the moment but I'd rather revisit this that if we can.

@sbrannen
Copy link
Member Author

I am not sure I understand that. Shouldn't we rather focus on whether this can be useful as a framework utility like plenty of others we don't use ourselves?

I think you might have missed the second half of the last sentence:

"or improve the documentation to make it clear what use cases it's suited for."

@snicoll
Copy link
Member

snicoll commented Oct 10, 2022

I didn't. I was expressing a vote for the second option while questioning the first.

@sbrannen sbrannen modified the milestones: 6.0.0-RC1, 6.0.0-RC2 Oct 10, 2022
@sbrannen
Copy link
Member Author

OK. If you think it's worth keeping the feature in Framework, we can change the title to focus on improving the documentation.

@snicoll snicoll changed the title Consider moving FilePatternResourceHintsRegistrar to Spring Boot Improve FilePatternResourceHintsRegistrar documentation Oct 10, 2022
@snicoll snicoll added type: documentation A documentation task and removed type: task A general task labels Oct 10, 2022
@snicoll snicoll modified the milestones: 6.0.0-RC2, 6.0.x Oct 17, 2022
@sbrannen sbrannen modified the milestones: 6.0.x, 6.1.x Mar 7, 2023
@Lalitha333
Copy link

Hi,
Is this still open? I'm new to open source contribution and would like to start with documentation. Thank you!

@jhoeller jhoeller modified the milestones: 6.1.x, 6.0.12 Aug 18, 2023
@jhoeller jhoeller added the in: core Issues in core modules (aop, beans, core, context, expression) label Aug 18, 2023
@snicoll
Copy link
Member

snicoll commented Aug 18, 2023

@Lalitha333 sorry, I missed that. Like any documentation request, this often turns out to be quite tricky and not really the right thing to get started.

@sbrannen
Copy link
Member Author

sbrannen commented Sep 7, 2023

Reopening due to a request from the Spring Boot team to introduce List<String> overrides of the new var-args methods used with the builder.

@sbrannen sbrannen reopened this Sep 7, 2023
@sbrannen sbrannen changed the title Improve FilePatternResourceHintsRegistrar documentation Revise FilePatternResourceHintsRegistrar API and improve documentation Sep 7, 2023
@sbrannen sbrannen self-assigned this Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: core Issues in core modules (aop, beans, core, context, expression) theme: aot An issue related to Ahead-of-time processing type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

4 participants