Skip to content

Commit

Permalink
Update feature deprecation guide (#30220)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mamaduka authored Apr 1, 2021
1 parent 0cbab3a commit 28893c2
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/how-to-guides/backward-compatibility/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,17 @@ As the project evolves, flaws of existing APIs are discovered, or updates are re

To encourage third-party developers to adopt the new APIs instead, we can use the [**deprecated**](/packages/deprecated/README.md) helper to show a message explaining the deprecation and propose the alternative whenever the old API is used.

Make it more clear when the feature was deprecated. Use the `since` and `plugin` options of the helper method.

Example:
```js
deprecated( 'wp.components.ClipboardButton', {
since: '10.3',
plugin: 'Gutenberg',
alternative: 'wp.compose.useCopyToClipboard',
} );
```

## Dev Notes

Dev notes are [posts published on the make/core site](https://make.wordpress.org/core/tag/dev-notes/) prior to WordPress releases to inform third-party developers about important changes to the developer APIs, these changes can include:
Expand Down

0 comments on commit 28893c2

Please sign in to comment.