unregisterPlugin: port old README docs to JSDoc

WordPress · Mar 6, 2019 · 47e366f · 47e366f
1 parent 45635b2
commit 47e366f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/packages/plugins/README.md b/packages/plugins/README.md
@@ -102,6 +102,13 @@ registerPlugin( 'plugin-name', {
 
 Unregisters a plugin by name.
 
+**Usage**
+
+```js
+const { unregisterPlugin } = wp.plugins;
+unregisterPlugin( 'plugin-name' );
+```
+
 **Parameters**
 
 -   **name** `string`: Plugin name.

diff --git a/packages/plugins/src/api/index.js b/packages/plugins/src/api/index.js
@@ -106,6 +106,12 @@ export function registerPlugin( name, settings ) {
  *
  * @param {string} name Plugin name.
  *
+ * @example
+ * ```js
+ * const { unregisterPlugin } = wp.plugins;
+ * unregisterPlugin( 'plugin-name' );
+ * ```
+ *
  * @return {?WPPlugin} The previous plugin settings object, if it has been
  *                     successfully unregistered; otherwise `undefined`.
  */