Changeset 10772 for sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/handbook.php

Timestamp:

03/05/2021 12:29:06 AM (6 years ago)

Author:

coffee2code

Message:

Handbooks, Init & Handbook: Move primary handbook config options array documentation to WPorg_Handbook::get_default_handbook_config().

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/handbook.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/handbook.php

@@ -75 +75 @@
                  * Filters default handbook configuration array.
                  *
-                 * @param string $slug The slug for the post type. Default is post type.
+                 * @param array $config {
+                 *     Associative array of handbook configuration.
+                 *
+                 *     @type string $label The label for the handbook. Default is the
+                 *                         post type slug converted to titlecase (e.g.
+                 *                         plugin-handbok => "Plugin Handbook").
+                 *     @type string $slug  The slug for the post type. Default is the
+                 *                         post type.
+                 * }
                  */
                 return (array) apply_filters( 'handbook_default_handbook_config', [