Permalink
Browse files

add explanation of null case

  • Loading branch information...
1 parent 9c52129 commit b37c34cc301fecc70e045b08e22873ca91c97ae5 @grangeway grangeway committed Mar 29, 2014
Showing with 2 additions and 1 deletion.
  1. +2 −1 core/current_user_api.php
@@ -204,7 +204,8 @@ function current_user_ensure_unprotected() {
/**
* Returns the issue filter parameters for the current user
*
- * @param int $p_project_id project id
+ * @param int $p_project_id project id. This argument is only used if a 'filter' string is not passed via the web request.
+ * The default value is null meaning return the current filter for user's current project if a filter string is not supplied.
* @return mixed Active issue filter for current user or false if no filter is currently defined.
* @access public
*/

0 comments on commit b37c34c

Please sign in to comment.