From a127b6d3b5980476e567b5c9ce0cd0c677d9509a Mon Sep 17 00:00:00 2001 From: vinogradov Date: Sat, 16 Jun 2018 01:48:24 +0400 Subject: [PATCH] Add explicit deprecation notes to Entity methods in docs --- docs/APIReference-Entity.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/APIReference-Entity.md b/docs/APIReference-Entity.md index fcadc3c4d5..221aaa4ff1 100644 --- a/docs/APIReference-Entity.md +++ b/docs/APIReference-Entity.md @@ -53,7 +53,7 @@ be used only for retrieval. ## Methods -### create +### create _(Deprecated in favour of [contentState.createEntity](/docs/api-reference-content-state.html#createentity))_ ``` create( @@ -70,7 +70,7 @@ are referenced by their string key in `ContentState`. The string value should be used within `CharacterMetadata` objects to track the entity for annotated characters. -### add +### add _(Deprecated in favour of [contentState.addEntity](/docs/api-reference-content-state.html#addentity))_ ``` add(instance: DraftEntityInstance): string @@ -83,7 +83,7 @@ created, and now need to be added to the `Entity` store. This may occur in cases where a vanilla JavaScript representation of a `ContentState` is being revived for editing. -### get +### get _(Deprecated in favour of [contentState.getEntity](/docs/api-reference-content-state.html#getentity))_ ``` get(key: string): DraftEntityInstance @@ -91,7 +91,7 @@ get(key: string): DraftEntityInstance Returns the `DraftEntityInstance` for the specified key. Throws if no instance exists for that key. -### mergeData +### mergeData _(Deprecated in favour of [contentState.mergeEntityData](/docs/api-reference-content-state.html#mergeentitydata))_ ``` mergeData( @@ -104,7 +104,7 @@ metadata through typical mutative means. The `mergeData` method allows you to apply updates to the specified entity. -### replaceData +### replaceData _(Deprecated in favour of [contentState.replaceEntityData](/docs/api-reference-content-state.html#replaceentitydata))_ ``` replaceData(