#937508 by amateescu: document the return value of arg() better
authorGábor Hojtsy
Wed, 3 Nov 2010 18:41:44 +0000 (18:41 +0000)
committerGábor Hojtsy
Wed, 3 Nov 2010 18:41:44 +0000 (18:41 +0000)
includes/path.inc

index 93c1fc5..eac6bde 100644 (file)
@@ -157,7 +157,8 @@ function drupal_get_normal_path($path, $path_language = '') {
  *
  * @return
  *   The component specified by $index, or NULL if the specified component was
- *   not found.
+ *   not found. If called without arguments, it returns an array containing all
+ *   the components of the current path.
  */
 function arg($index = NULL, $path = NULL) {
   static $arguments;