-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
docs: Introduce deprecation ID for reference in comments and online search #7562
Merged
Conversation
This file contains 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
Thanks for opening this pull request!
|
🎉 This change has been released in version 5.0.0-beta.1 |
Merged
🎉 This change has been released in version 5.0.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
New Pull Request Checklist
Issue Description
Deprecations currently have no unique ID to refer to them in code comments and for developers in online search and forums.
This also makes it difficult to identify code blocks that may be added in anticipation of the removal of a feature without being able to properly reference a deprecation.
Related issue: #n/a
Approach
Add deprecation ID to deprecation table, following syntax:
Example for "Deprecation - Parse Server - 1":
This allows to reference server deprecations in SDK without conflict, while allowing to cross-reference deprecations.
Example:
Deprecation no. 1 in Parse JS SDK
DEPPJSS1
can be related to Deprecation no. 1 in Parse ServerDEPPS1
.TODOs before merging