Lightly clean up and improve inline documentation in wp-config-sample.php.

* Fixes some grammatical and wrapping issues in the file header, and breaks the contents list up into, well, a list.
* Adds a note and Codex link to the DocBlock for the `WP_DEBUG` constant definition on where to find more information about constants used for debugging.

Fixes #28551.

Built from https://develop.svn.wordpress.org/trunk@32479


git-svn-id: http://core.svn.wordpress.org/trunk@32449 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-05-10 00:06:31 +00:00
parent 7ad60f3154
commit 59fe6b2368
2 changed files with 20 additions and 11 deletions

View File

@ -1,15 +1,19 @@
<?php <?php
/** /**
* The base configurations of the WordPress. * The base configuration for WordPress
* *
* This file has the following configurations: MySQL settings, Table Prefix, * The wp-config.php creation script uses this file during the
* Secret Keys, and ABSPATH. You can find more information by visiting * installation. You don't have to use the web site, you can
* {@link https://codex.wordpress.org/Editing_wp-config.php Editing wp-config.php} * copy this file to "wp-config.php" and fill in the values.
* Codex page. You can get the MySQL settings from your web host.
* *
* This file is used by the wp-config.php creation script during the * This file contains the following configurations:
* installation. You don't have to use the web site, you can just copy this file *
* to "wp-config.php" and fill in the values. * * MySQL settings
* * Secret keys
* * Database table prefix
* * ABSPATH
*
* @link https://codex.wordpress.org/Editing_wp-config.php
* *
* @package WordPress * @package WordPress
*/ */
@ -56,8 +60,8 @@ define('NONCE_SALT', 'put your unique phrase here');
/** /**
* WordPress Database Table prefix. * WordPress Database Table prefix.
* *
* You can have multiple installations in one database if you give each a unique * You can have multiple installations in one database if you give each
* prefix. Only numbers, letters, and underscores please! * a unique prefix. Only numbers, letters, and underscores please!
*/ */
$table_prefix = 'wp_'; $table_prefix = 'wp_';
@ -67,6 +71,11 @@ $table_prefix = 'wp_';
* Change this to true to enable the display of notices during development. * Change this to true to enable the display of notices during development.
* It is strongly recommended that plugin and theme developers use WP_DEBUG * It is strongly recommended that plugin and theme developers use WP_DEBUG
* in their development environments. * in their development environments.
*
* For information on other constants that can be used for debugging,
* visit the Codex.
*
* @link https://codex.wordpress.org/Debugging_in_WordPress
*/ */
define('WP_DEBUG', false); define('WP_DEBUG', false);

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.3-alpha-32478'; $wp_version = '4.3-alpha-32479';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.