summaryrefslogtreecommitdiff
path: root/includes
diff options
context:
space:
mode:
authorDavid Rothstein <drothstein@gmail.com>2015-10-14 16:24:06 -0400
committerDavid Rothstein <drothstein@gmail.com>2015-10-14 16:24:06 -0400
commit9c5cd0c6064ff569b750277248832405e61f931e (patch)
tree6213e3b545c9ebadbf72ba465df0eb714201d8a5 /includes
parente2050b5758785d78684f3692900475b2e6553888 (diff)
downloadbrdo-9c5cd0c6064ff569b750277248832405e61f931e.tar.gz
brdo-9c5cd0c6064ff569b750277248832405e61f931e.tar.bz2
Issue #2530872 by orbmantell, TravisCarden: Improve documentation of drupal_get_schema() and drupal_get_schema_unprocessed()
Diffstat (limited to 'includes')
-rw-r--r--includes/bootstrap.inc4
-rw-r--r--includes/common.inc3
2 files changed, 5 insertions, 2 deletions
diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc
index 70d426b4a..ea768930c 100644
--- a/includes/bootstrap.inc
+++ b/includes/bootstrap.inc
@@ -2959,7 +2959,9 @@ function ip_address() {
* Gets the schema definition of a table, or the whole database schema.
*
* The returned schema will include any modifications made by any
- * module that implements hook_schema_alter().
+ * module that implements hook_schema_alter(). To get the schema without
+ * modifications, use drupal_get_schema_unprocessed().
+ *
*
* @param $table
* The name of the table. If not given, the schema of all tables is returned.
diff --git a/includes/common.inc b/includes/common.inc
index e5e8150dc..bb27d391e 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -7098,7 +7098,8 @@ function drupal_uninstall_schema($module) {
* specification of a schema, as it was defined in a module's
* hook_schema(). No additional default values will be set,
* hook_schema_alter() is not invoked and these unprocessed
- * definitions won't be cached.
+ * definitions won't be cached. To retrieve the schema after
+ * hook_schema_alter() has been invoked use drupal_get_schema().
*
* This function can be used to retrieve a schema specification in
* hook_schema(), so it allows you to derive your tables from existing