diff --git a/packages/shortcode/README.md b/packages/shortcode/README.md index dc7df6b0b4508..4fc494b224206 100644 --- a/packages/shortcode/README.md +++ b/packages/shortcode/README.md @@ -38,7 +38,7 @@ or `name=value`. Numeric attributes can be formatted as `"value"` or just **Returns** -`WPShortcodeAttrs` Parsed shortcode attributes. +`WPShortcodeAttrs`: Parsed shortcode attributes. ### default @@ -57,7 +57,7 @@ the `type` of the shortcode ('single', 'self-closing', or 'closed'), and a **Returns** -`WPShortcode` Shortcode instance. +`WPShortcode`: Shortcode instance. ### fromMatch @@ -75,7 +75,7 @@ passed to `regexp.replace()`. **Returns** -`WPShortcode` Shortcode instance. +`WPShortcode`: Shortcode instance. ### next @@ -91,7 +91,7 @@ Find the next matching shortcode. **Returns** -`?WPShortcodeMatch` Matched information. +`?WPShortcodeMatch`: Matched information. ### regexp @@ -118,7 +118,7 @@ Capture groups: **Returns** -`RegExp` Shortcode RegExp. +`RegExp`: Shortcode RegExp. ### replace @@ -134,7 +134,7 @@ Replace matching shortcodes in a block of text. **Returns** -`string` Text with shortcodes replaced. +`string`: Text with shortcodes replaced. ### string @@ -154,7 +154,7 @@ format the shortcode using a `single` tag, and a `content` string. **Returns** -`string` String representation of the shortcode. +`string`: String representation of the shortcode.