This repository has been archived by the owner on Feb 6, 2023. It is now read-only.
Docs: add explicit deprecation notes to Entity methods #1787
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
There was a problem hiding this comment.
niveditc is landing this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
jdecked
pushed a commit
to twitter-forks/draft-js
that referenced
this pull request
Oct 9, 2019
…ve#1787) Summary: **Summary** The note in the docs `Please note that the API for entity storage and management has changed recently; for details on updating your application see our v0.10 API Migration Guide` doesn't give a quick clear idea of what I should use instead of the old methods (I need to go to that migration guide, but let's suppose I'm a new user and I don't have any code to migrate). The problem becomes obvious after getting warnings in the browser console. So my suggestion is to place deprecation notice right in the name header. I believe this would save some time for those who open docs just to see the method signatures. Now (https://draftjs.org/docs/api-reference-entity.html):  What I suggest:  Pull Request resolved: facebookarchive#1787 Differential Revision: D10234733 fbshipit-source-id: 8f7c32ad4f0da203ffe0a80584781413681ba158
alicayan008
pushed a commit
to alicayan008/draft-js
that referenced
this pull request
Jul 4, 2023
Summary: **Summary** The note in the docs `Please note that the API for entity storage and management has changed recently; for details on updating your application see our v0.10 API Migration Guide` doesn't give a quick clear idea of what I should use instead of the old methods (I need to go to that migration guide, but let's suppose I'm a new user and I don't have any code to migrate). The problem becomes obvious after getting warnings in the browser console. So my suggestion is to place deprecation notice right in the name header. I believe this would save some time for those who open docs just to see the method signatures. Now (https://draftjs.org/docs/api-reference-entity.html):  What I suggest:  Pull Request resolved: facebookarchive/draft-js#1787 Differential Revision: D10234733 fbshipit-source-id: 8f7c32ad4f0da203ffe0a80584781413681ba158
aforismesen
added a commit
to aforismesen/draft-js
that referenced
this pull request
Jul 12, 2024
Summary: **Summary** The note in the docs `Please note that the API for entity storage and management has changed recently; for details on updating your application see our v0.10 API Migration Guide` doesn't give a quick clear idea of what I should use instead of the old methods (I need to go to that migration guide, but let's suppose I'm a new user and I don't have any code to migrate). The problem becomes obvious after getting warnings in the browser console. So my suggestion is to place deprecation notice right in the name header. I believe this would save some time for those who open docs just to see the method signatures. Now (https://draftjs.org/docs/api-reference-entity.html):  What I suggest:  Pull Request resolved: facebookarchive/draft-js#1787 Differential Revision: D10234733 fbshipit-source-id: 8f7c32ad4f0da203ffe0a80584781413681ba158
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
The note in the docs
Please note that the API for entity storage and management has changed recently; for details on updating your application see our v0.10 API Migration Guidedoesn't give a quick clear idea of what I should use instead of the old methods (I need to go to that migration guide, but let's suppose I'm a new user and I don't have any code to migrate). The problem becomes obvious after getting warnings in the browser console. So my suggestion is to place deprecation notice right in the name header. I believe this would save some time for those who open docs just to see the method signatures.Now (https://draftjs.org/docs/api-reference-entity.html):
What I suggest:
