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

Write-up of opt-in deprecation warnings? #5422

Closed
svix-jplatte opened this issue Mar 25, 2024 · 4 comments
Closed

Write-up of opt-in deprecation warnings? #5422

svix-jplatte opened this issue Mar 25, 2024 · 4 comments

Comments

@svix-jplatte
Copy link

Hi, I just went through #3822 and other related GitHub / reddit threads to find a summary of the opt-in deprecation scheme that clap ended up with. Is my memory serving me wrong that such a write-up exists?

@epage
Copy link
Member

epage commented Mar 25, 2024

Are you looking for justification for it, an explanation of the mechanics / pattern, or user facing "how to opt-in"?

@svix-jplatte
Copy link
Author

svix-jplatte commented Mar 25, 2024

Mostly an explanation of the pattern (I think there's not much to it, simple cfg-gated deprecation attributes?), probably with the motivation as an introduction. I thought I saw something like that before 😅

Context: wanted to link to it as prior art when mentioning the pattern for another project.

@epage
Copy link
Member

epage commented Mar 25, 2024

#3830 is the main place I can think of which is linked to in the above. That included updates to our compatibility documentation and shows how we did this. One of the key things that requires extra work is when proc-macros need to call deprecated functionality.

@svix-jplatte
Copy link
Author

svix-jplatte commented Mar 25, 2024

Okay, so I guess I was imagining that there was a separate document / article about this pattern. Thanks 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants