From 9b7e00ac77f0fa15b0b941bb15c54f28f320806c Mon Sep 17 00:00:00 2001
From: Lars Toomre <ltoomre@23809.no-reply.drupal.org>
Date: Tue, 25 Sep 2012 13:46:41 -0400
Subject: [PATCH] Small documentation changes.

---
 core/modules/ban/ban.admin.inc |   13 +++++++------
 core/modules/ban/ban.module    |   21 ++++++++++-----------
 2 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/core/modules/ban/ban.admin.inc b/core/modules/ban/ban.admin.inc
index d7940f9..40711b8 100644
--- a/core/modules/ban/ban.admin.inc
+++ b/core/modules/ban/ban.admin.inc
@@ -6,11 +6,13 @@
  */
 
 /**
- * Page callback; Displays banned IP addresses.
+ * Page callback: Displays banned IP addresses.
  *
  * @param string $default_ip
- *   (optional) IP address to be passed on to drupal_get_form() for
- *   use as the default value of the IP address form field.
+ *   (optional) IP address to be passed on to drupal_get_form() for use as the
+ *   default value of the IP address form field.
+ *
+ * @see ban_menu()
  */
 function ban_admin_page($default_ip = '') {
   $rows = array();
@@ -41,9 +43,8 @@ function ban_admin_page($default_ip = '') {
  * @param string $default_ip
  *   An IP address to ban, used as default value.
  *
- * @see ban_ip_form_validate()
  * @see ban_ip_form_submit()
- *
+ * @see ban_ip_form_validate()
  * @ingroup forms
  */
 function ban_ip_form($form, &$form_state, $default_ip) {
@@ -109,7 +110,7 @@ function ban_ip_delete_form($form, &$form_state, array $ban_ip) {
     '#value' => $ban_ip,
   );
   return confirm_form($form,
-    t('Are you sure you want to delete %ip?', array('%ip' => $ban_ip['ip'])),
+    t('Are you sure you want to remove the ban on %ip?', array('%ip' => $ban_ip['ip'])),
     'admin/config/people/ban',
     NULL,
     t('Delete')
diff --git a/core/modules/ban/ban.module b/core/modules/ban/ban.module
index 149ada9..a0d4909 100644
--- a/core/modules/ban/ban.module
+++ b/core/modules/ban/ban.module
@@ -2,7 +2,7 @@
 
 /**
  * @file
- * Enables banning of IP addresses.
+ * Provides capability to ban individual IP addresses.
  */
 
 /**
@@ -13,11 +13,11 @@ function ban_help($path, $arg) {
     case 'admin/help#ban':
       $output = '';
       $output .= '<h3>' . t('About') . '</h3>';
-      $output .= '<p>' . t('The Ban module allows administrators to ban visits to their site from given IP addresses.') . '</p>';
+      $output .= '<p>' . t('The Ban module allows administrators to ban visits to their site from individual IP addresses.') . '</p>';
       $output .= '<h3>' . t('Uses') . '</h3>';
       $output .= '<dl>';
       $output .= '<dt>' . t('Banning IP addresses') . '</dt>';
-      $output .= '<dd>' . t('Administrators can enter IP addresses to ban on the <a href="@bans">IP address bans</a> page.', array('@bans' => url('admin/config/people/ban'))) . '</dd>';
+      $output .= '<dd>' . t('Administrators can enter individual IP addresses to ban on the <a href="@bans">IP address bans</a> page.', array('@bans' => url('admin/config/people/ban'))) . '</dd>';
       $output .= '</dl>';
       return $output;
 
@@ -67,10 +67,10 @@ function ban_boot() {
 }
 
 /**
- * Returns whether an IP address is blocked.
+ * Returns whether an individual IP address is blocked.
  *
  * Blocked IP addresses are stored in the database by default. However, for
- * performance reasons we allow an override in variables.
+ * performance reasons, we allow an override in variables.
  *
  * @param string $ip
  *   The IP address to check.
@@ -80,18 +80,17 @@ function ban_boot() {
  */
 function ban_is_denied($ip) {
   $denied = FALSE;
-  // Because this function is called on every page request, we first check
-  // for an array of IP addresses in settings.php before querying the
-  // database.
+  // Because this function is called on every page request, we first check for
+  // an array of IP addresses in settings.php before querying the database.
   $blocked_ips = variable_get('blocked_ips');
   if (isset($blocked_ips) && is_array($blocked_ips)) {
     $denied = in_array($ip, $blocked_ips);
   }
   // If $conf['page_cache_without_database'] = TRUE; is set in settings.php,
   // then the database is not available yet, so IPs recorded in the database
-  // won't be denied. However, the user asked explicitly not to use the
-  // database, and in this case it's also quite likely that the user relies
-  // on higher performance solutions like a firewall.
+  // will not be denied. However, the user asked explicitly not to use the
+  // database, and in this case it is also quite likely that the user relies on
+  // higher performance solutions like a firewall.
   elseif (class_exists('Drupal\Core\Database\Database', FALSE) && function_exists('db_query')) {
     $denied = (bool) db_query("SELECT 1 FROM {ban_ip} WHERE ip = :ip", array(':ip' => $ip))->fetchField();
   }
-- 
1.7.6.msysgit.0