From 28a535e58ba13cb7e78ab601362ff1c564c5d2f6 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <drewapicture@git.wordpress.org>
Date: Sun, 10 May 2015 00:05:30 +0000
Subject: [PATCH] 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@32479 602fd350-edb4-49c9-b593-d223f7449a82
---
 wp-config-sample.php | 29 +++++++++++++++++++----------
 1 file changed, 19 insertions(+), 10 deletions(-)

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