From 9af602fe17e6346360e640e403843494c84ecca0 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Sun, 26 Apr 2009 07:50:51 +0000
Subject: [PATCH] - Patch #432864 by mcrittenden, franskuipers: improved
 documentation for base_path().

---
 includes/common.inc | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/includes/common.inc b/includes/common.inc
index 2e8ef30108b..98d5760f511 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -1938,8 +1938,18 @@ function drupal_get_path($type, $name) {
 }
 
 /**
- * Returns the base URL path of the Drupal installation.
- * At the very least, this will always default to /.
+ * Returns the base URL path of the Drupal installation, i.e.,
+ * the directory where Drupal is installed. At the very least,
+ * this will return "/".
+ *
+ * NOTE: base_path prefixes and suffixes a "/" onto the returned
+ * path if the path is not empty. See examples below.
+ *
+ * Example #1: Drupal installed at "http://yoursite.com" means
+ * this will just return "/" because the path is empty.
+ *
+ * Example #2: Drupal installed at "http://yoursite.com/drupal/folder"
+ * means this function will return "/drupal/folder/".
  */
 function base_path() {
   return $GLOBALS['base_path'];