Skip to content

Update javadoc of Configurer classes that apply sensible defaults to describe how they're typically used #42878

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.

Sign up for GitHub

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

Jump to bottom
Closed
philwebb opened this issue Oct 25, 2024 · 5 comments
Closed

Update javadoc of Configurer classes that apply sensible defaults to describe how they're typically used #42878

philwebb opened this issue Oct 25, 2024 · 5 comments
Assignees
@wilkinsona
Labels
type: documentation A documentation update
Milestone
3.3.13

Comments

@philwebb
Copy link
Member

philwebb commented Oct 25, 2024 •
edited
Loading

We considered deprecating them because I'm was not sure they were really necessary anymore. But they are designed for users to inject. We could update the javadoc to help folks understand the pattern.
@philwebb philwebb added the type: task A general task label Oct 25, 2024
@philwebb philwebb added this to the 3.x milestone Oct 25, 2024
@philwebb philwebb added for: team-meeting An issue we'd like to discuss as a team to make progress status: pending-design-work Needs design work before any code can be developed labels Oct 26, 2024
@philwebb
Copy link
Member Author

They are designed to be injected by users so that they can configure their own instances. We should keep them.

@philwebb philwebb changed the title Consider deprecating RestTemplateBuilderConfigurer and RestClientBuilderConfigurer Update javadoc for RestTemplateBuilderConfigurer and RestClientBuilderConfigurer Nov 14, 2024
@philwebb philwebb added type: documentation A documentation update and removed type: task A general task status: pending-design-work Needs design work before any code can be developed for: team-meeting An issue we'd like to discuss as a team to make progress labels Nov 14, 2024
@philwebb philwebb modified the milestones: 3.x, 3.2.x, 3.3.x Nov 14, 2024
@bhargavsai007
Copy link

Hi @philwebb . I have 3 years of experience with Spring Boot. I would like to start contributing to this Open Source community. So I would like to work on this issue. Could you help me in getting started ?

Thanks

@philwebb
Copy link
Member Author

philwebb commented Feb 12, 2025 •
edited by wilkinsona
Loading

Thanks for the offer @bhargavsai007, but I'm not sure exactly what we want the javadoc to say yet. Once we work that out, it will be simpler for us to update the code directly. Please keep your eye open for issues labeled with status: ideal-for-contribution An issue that a contributor can help us with if you're looking to help.

@bhargavsai007
Copy link

No problem @philwebb . Thanks for your suggestion, will look into it.

@wilkinsona wilkinsona changed the title Update javadoc for RestTemplateBuilderConfigurer and RestClientBuilderConfigurer Update javadoc of Configurer classes that apply sensible defaults to describe how they're typically used May 23, 2025
@wilkinsona
Copy link
Member

There are some other classes that would benefit from a similar improvement to their javadoc:

@wilkinsona wilkinsona self-assigned this May 23, 2025
@wilkinsona wilkinsona mentioned this issue May 23, 2025
Closed
@wilkinsona wilkinsona modified the milestones: 3.3.x, 3.3.13 May 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wilkinsona wilkinsona

Labels
type: documentation A documentation update
Projects
None yet
Milestone
3.3.13
Development

No branches or pull requests
3 participants
@philwebb @wilkinsona @bhargavsai007