From: Ian Jackson <ian.jackson@eu.citrix.com>
Date: Tue, 27 Oct 2015 18:47:10 +0000 (+0000)
Subject: Docs: Clarify url_with_query_params $params
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=cgi-auth-flexible.git;a=commitdiff_plain;h=18a0a073c0e61b4159ffad1fd00db00a445c4156;ds=inline

Docs: Clarify url_with_query_params $params

It doesn't want CAF-specific parameters: it will put those in for
itself.

Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
---

diff --git a/caf.pod b/caf.pod
index 4277923..90b15db 100644
--- a/caf.pod
+++ b/caf.pod
@@ -420,7 +420,8 @@ C<check_mutate>.
 Convenience function which returns a url for a GET request to this
 application.
 
-I<$params> is a hashref specifying the parameters and the PATH_INFO.
+I<$params> is a hashref specifying the parameters and the PATH_INFO
+(not including any parameters related to CGI::Auth::Flexible).
 The keys are the parameter names, and the values are array refs with
 the parameter value(s) (as strings, as yet unquoted).  (They are array
 refs because it is possible to pass multiple values for the same