Changeset 63598 for trunk/src/js/_enqueues/wp/api.js

Timestamp:

09/11/2026 06:29:08 AM (10 hours ago)

Author:

afercia

Message:

General: Enable the JSDoc rule require-param-description.

Enables the JSDoc rule require-param-description and fixes all the reported violations.
Part of the effort to improve JS inline documentation for 7.2.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/13475

Props afercia, westonruter.
See #66033.

File:

• trunk/src/js/_enqueues/wp/api.js (modified) (1 diff)

trunk/src/js/_enqueues/wp/api.js

@@ -1547 +1547 @@
          * Initialize the wp-api, optionally passing the API root.
          *
-         * @param {Object} [args]
+         * @param {Object} [args]               The arguments for initializing the wp-api.
          * @param {string} [args.nonce]         The nonce. Optional, defaults to wpApiSettings.nonce.
          * @param {string} [args.apiRoot]       The api root. Optional, defaults to wpApiSettings.root.