summaryrefslogtreecommitdiffstatshomepage
path: root/src/js
diff options
context:
space:
mode:
authorSergey Biryukov <sergeybiryukov@git.wordpress.org>2020-07-28 00:05:59 +0000
committerSergey Biryukov <sergeybiryukov@git.wordpress.org>2020-07-28 00:05:59 +0000
commit72dfc468c5ce498380cb1edd966a81fc46cd385e (patch)
tree909e6f1395044afd0c75f63183aa455651888517 /src/js
parent9ed92faaca92f66ec9e2979c9d896ddab3e4e993 (diff)
downloadwordpress-72dfc468c5ce498380cb1edd966a81fc46cd385e.tar.gz
wordpress-72dfc468c5ce498380cb1edd966a81fc46cd385e.zip
Docs: Correct alignment for some parameters in JS documentation.
Follow-up to [48650]. See #43828. git-svn-id: https://develop.svn.wordpress.org/trunk@48651 602fd350-edb4-49c9-b593-d223f7449a82
Diffstat (limited to 'src/js')
-rw-r--r--src/js/_enqueues/lib/image-edit.js4
-rw-r--r--src/js/_enqueues/wp/api.js4
-rw-r--r--src/js/_enqueues/wp/customize/controls.js4
-rw-r--r--src/js/_enqueues/wp/customize/selective-refresh.js16
4 files changed, 14 insertions, 14 deletions
diff --git a/src/js/_enqueues/lib/image-edit.js b/src/js/_enqueues/lib/image-edit.js
index 639e7d63e8..8e3a8657da 100644
--- a/src/js/_enqueues/lib/image-edit.js
+++ b/src/js/_enqueues/lib/image-edit.js
@@ -73,7 +73,7 @@
* @memberof imageEdit
*
* @param {jQuery} el The element that should be modified.
- * @param {boolean|number} s The state for the element. If set to true
+ * @param {boolean|number} s The state for the element. If set to true
* the element is disabled,
* otherwise the element is enabled.
* The function is sometimes called with a 0 or 1
@@ -841,7 +841,7 @@
* @memberof imageEdit
*
* @param {number} postid The post ID.
- * @param {boolean} warn Warning message.
+ * @param {boolean} warn Warning message.
*
* @return {void|boolean} Returns false if there is a warning.
*/
diff --git a/src/js/_enqueues/wp/api.js b/src/js/_enqueues/wp/api.js
index 6484e9d2b6..eb3bb842ab 100644
--- a/src/js/_enqueues/wp/api.js
+++ b/src/js/_enqueues/wp/api.js
@@ -186,7 +186,7 @@
* Extract a route part based on negative index.
*
* @param {string} route The endpoint route.
- * @param {number} part The number of parts from the end of the route to retrieve. Default 1.
+ * @param {number} part The number of parts from the end of the route to retrieve. Default 1.
* Example route `/a/b/c`: part 1 is `c`, part 2 is `b`, part 3 is `a`.
* @param {string} [versionString] Version string, defaults to `wp.api.versionString`.
* @param {boolean} [reverse] Whether to reverse the order when extracting the route part. Optional, default false.
@@ -361,7 +361,7 @@
* Build a helper function to retrieve related model.
*
* @param {string} parentModel The parent model.
- * @param {number} modelId The model ID if the object to request
+ * @param {number} modelId The model ID if the object to request
* @param {string} modelName The model name to use when constructing the model.
* @param {string} embedSourcePoint Where to check the embedds object for _embed data.
* @param {string} embedCheckField Which model field to check to see if the model has data.
diff --git a/src/js/_enqueues/wp/customize/controls.js b/src/js/_enqueues/wp/customize/controls.js
index 57d972c213..484ac5a49b 100644
--- a/src/js/_enqueues/wp/customize/controls.js
+++ b/src/js/_enqueues/wp/customize/controls.js
@@ -2166,8 +2166,8 @@
* Loads controls into the section from data received from loadThemes().
*
* @since 4.9.0
- * @param {Array} themes - Array of theme data to create controls with.
- * @param {number} page - Page of results being loaded.
+ * @param {Array} themes - Array of theme data to create controls with.
+ * @param {number} page - Page of results being loaded.
* @return {void}
*/
loadControls: function( themes, page ) {
diff --git a/src/js/_enqueues/wp/customize/selective-refresh.js b/src/js/_enqueues/wp/customize/selective-refresh.js
index 7150c8722b..2967d45152 100644
--- a/src/js/_enqueues/wp/customize/selective-refresh.js
+++ b/src/js/_enqueues/wp/customize/selective-refresh.js
@@ -59,14 +59,14 @@ wp.customize.selectiveRefresh = ( function( $, api ) {
*
* @since 4.5.0
*
- * @param {string} id - Unique identifier for the partial instance.
- * @param {Object} options - Options hash for the partial instance.
- * @param {string} options.type - Type of partial (e.g. nav_menu, widget, etc)
- * @param {string} options.selector - jQuery selector to find the container element in the page.
- * @param {Array} options.settings - The IDs for the settings the partial relates to.
- * @param {string} options.primarySetting - The ID for the primary setting the partial renders.
- * @param {boolean} options.fallbackRefresh - Whether to refresh the entire preview in case of a partial refresh failure.
- * @param {Object} [options.params] - Deprecated wrapper for the above properties.
+ * @param {string} id - Unique identifier for the partial instance.
+ * @param {Object} options - Options hash for the partial instance.
+ * @param {string} options.type - Type of partial (e.g. nav_menu, widget, etc)
+ * @param {string} options.selector - jQuery selector to find the container element in the page.
+ * @param {Array} options.settings - The IDs for the settings the partial relates to.
+ * @param {string} options.primarySetting - The ID for the primary setting the partial renders.
+ * @param {boolean} options.fallbackRefresh - Whether to refresh the entire preview in case of a partial refresh failure.
+ * @param {Object} [options.params] - Deprecated wrapper for the above properties.
*/
initialize: function( id, options ) {
var partial = this;