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

Consider adding "since" attribute on DeprecatedConfigurationProperty #21018

Open
snicoll opened this issue Apr 19, 2020 · 0 comments
Open

Consider adding "since" attribute on DeprecatedConfigurationProperty #21018

snicoll opened this issue Apr 19, 2020 · 0 comments
Labels
type: enhancement A general enhancement
Milestone

Comments

@snicoll
Copy link
Member

snicoll commented Apr 19, 2020

When deprecating a configuration property, it is not always obvious when we did that. We could mention that in the Javadoc of the getter but the documentation for the property is set on the field so it's not natural for us to repeat it there.

Perhaps a since extra attribute that we'd use solely for the purpose of tracking could be an idea? Or perhaps we could generate that information in the metadata as well in case that's useful to users?

See #20812 (comment)

@snicoll snicoll added the status: waiting-for-triage An issue we've not yet triaged label Apr 19, 2020
@philwebb philwebb added type: enhancement A general enhancement and removed status: waiting-for-triage An issue we've not yet triaged labels Apr 19, 2020
@philwebb philwebb added this to the 2.3.x milestone Apr 19, 2020
@snicoll snicoll added the for: team-attention An issue we'd like other members of the team to review label Apr 22, 2020
@philwebb philwebb modified the milestones: 2.3.x, 2.x Apr 22, 2020
@philwebb philwebb removed the for: team-attention An issue we'd like other members of the team to review label Apr 22, 2020
@philwebb philwebb modified the milestones: 2.x, 3.x Aug 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement A general enhancement
Projects
None yet
Development

No branches or pull requests

2 participants