diff options
| author | Sergey Biryukov <sergeybiryukov@git.wordpress.org> | 2019-11-29 17:59:47 +0000 |
|---|---|---|
| committer | Sergey Biryukov <sergeybiryukov@git.wordpress.org> | 2019-11-29 17:59:47 +0000 |
| commit | a03bb5454673d62dae26f50cd13619e92b23c884 (patch) | |
| tree | faac09874cdb44e25548961f163c0f8a06dc9028 /src/js/_enqueues/wp/a11y.js | |
| parent | ea5bfe134f50b91680369f50b4d12d233b1f917c (diff) | |
| download | wordpress-a03bb5454673d62dae26f50cd13619e92b23c884.tar.gz wordpress-a03bb5454673d62dae26f50cd13619e92b23c884.zip | |
Docs: Replace `@returns` tags in JS docs with `@return`.
Per the documentation standards, `@returns` is an unsupported synonym, `@return` should be used instead:
https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/
See #48303.
git-svn-id: https://develop.svn.wordpress.org/trunk@46800 602fd350-edb4-49c9-b593-d223f7449a82
Diffstat (limited to 'src/js/_enqueues/wp/a11y.js')
| -rw-r--r-- | src/js/_enqueues/wp/a11y.js | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/js/_enqueues/wp/a11y.js b/src/js/_enqueues/wp/a11y.js index 648b629d37..3869dd3c3d 100644 --- a/src/js/_enqueues/wp/a11y.js +++ b/src/js/_enqueues/wp/a11y.js @@ -21,7 +21,7 @@ window.wp = window.wp || {}; * @param {String} message The message to be announced by Assistive Technologies. * @param {String} [ariaLive] The politeness level for aria-live. Possible values: * polite or assertive. Default polite. - * @returns {void} + * @return {void} */ function speak( message, ariaLive ) { // Clear previous messages to allow repeated strings being read out. |