document deprecation utils#18809
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the module-level deprecation utilities introduced in #18571. The documentation explains how to use the utils._deprecate module's handleDeprecations factory function and its associated DeprecatedSymbol subclasses to systematically handle API deprecations.
- Documents the
handleDeprecationsfactory function andDeprecatedSymbolsubclasses (MovedSymbol,RemovedSymbol) - Provides a practical example showing how to deprecate symbols that are moved or removed
- Improves formatting and structure of the existing deprecations documentation
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
seanbudd
approved these changes
Aug 26, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Link to issue number:
Follow-up to #18571
Summary of the issue:
As part of #18571, I wrote code that made handling a large number of module-level deprecations easier. Since this code made handling module-level deprecations more systematic and auditable, the code was split out into its own module.
As we wanted to get #18571 merged to unblock other work, documentation for that utility was not added in that PR.
Description of user facing changes:
None
Description of developer facing changes:
Adds documentation on the novel strategy for handling module-level deprecations.
Description of development approach:
Wrote documentation.
Testing strategy:
None.
Known issues with pull request:
None.
Code Review Checklist: