Skip to content

Conversation

@quaff
Copy link
Contributor

@quaff quaff commented Jun 17, 2021

No description provided.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jun 17, 2021
@quaff quaff force-pushed the main branch 3 times, most recently from cfe4094 to 57cbfc1 Compare June 17, 2021 01:51
@snicoll
Copy link
Member

snicoll commented Jun 17, 2021

Thanks for the PR but I think the use of @Configuration here is deliberate as we may not want to get into the details of what @SpringBootConfiguration does compared to the regular @Configuration. I've flagged for team attention to get more feedback.

@snicoll snicoll added the for: team-attention An issue we'd like other members of the team to review label Jun 17, 2021
@wilkinsona
Copy link
Member

To me, the current documentation reads as if you could replace @SpringBootApplication with @EnableAutoConfiguration, @ComponentScan, and @Configuration and get the same behaviour. That's not the case as using @Configuration rather than @SpringBootConfiguration may break some of your tests. With this in mind, I think the proposed changes are an improvement. We could perhaps go a small step further and cross-link to the testing section that discusses @SpringBootConfiguration.

@snicoll
Copy link
Member

snicoll commented Jun 17, 2021

Thanks for the feedback. I've re-read the section and we're already mentioning quite advanced details about @ComponentScan. That nullifies my previous argument.

@snicoll snicoll added type: documentation A documentation update and removed for: team-attention An issue we'd like other members of the team to review status: waiting-for-triage An issue we've not yet triaged labels Jun 17, 2021
@snicoll snicoll added this to the 2.4.x milestone Jun 17, 2021
@wilkinsona wilkinsona changed the title Fix outdated docs not consistent with code Update reference documentation to reflect @SpringBootApplication's use of @SpringBootConfiguration Jun 17, 2021
@wilkinsona wilkinsona self-assigned this Jun 22, 2021
@wilkinsona wilkinsona modified the milestones: 2.4.x, 2.4.8 Jun 22, 2021
@wilkinsona
Copy link
Member

Thanks very much, @quaff.

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.

4 participants