Changeset 10772

Timestamp:

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

Author:

coffee2code

Message:

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

Location:

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

Files:

• handbook.php (modified) (1 diff)
• init.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', [

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

@@ -118 +118 @@
          * Defines and configures all handbooks.
          *
-         * @param array $config {
-         *     Associative array of post types and their configuration options. The keys should actually be
-         *     the post type base, hypenated and without appending '-handbook' (which will automatically get
-         *     appended when the handbook post type is created, if the key isn't "handbook"). Default is 'handbook'.
+         * @see WPorg_Handbook::get_default_handbook_config()
          *
-         *     @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.
-         * }
+         * @param array $config Associative array of handbooks and their
+         *                      configuration options. Keys should be the handbook
+         *                      post type (which will get appended '-handbook' if
+         *                      the post type isn't 'handbook' and doesn't already
+         *                      contain '-handbook'. See
+         *                      {@see WPorg_Handbook::get_default_handbook_config()}
+         *                      for list of per-handbook configuration options.
          */
         $config = (array) apply_filters( 'handbooks_config', $config );