Skip Menu |

Preferred bug tracker

Please visit the preferred bug tracker to report your issue.

This queue is for tickets about the CGI CPAN distribution.

Report information
The Basics
Id: 48370
Status: resolved
Priority: 0/
Queue: CGI

People
Owner: Nobody in particular
Requestors: MARKSTOS [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: (no value)
Fixed in: (no value)



Subject: Needs peer review: docs for query_string should be updated
The docs for the query_string() method currently say this: "You can also retrieve the unprocessed query string with query_string()" However, I think the "unprocessed" bit is not true. I think the unprocessed query string would be $ENV{QUERY_STRING}. Instead, what query_string() is to build a query string based on the *processed* query string each time. Then a newly constructed query string is emitted, with your choice of semicolon or ampersand delimiters, regardless of what an input query string may have had. I recommend these docs be updated as follows: "You can also retrieve a query string representation of the current object state with query_string()" I'd like someone else to peer review this change and provide an opinion on the issue.
For what it's worth as a CGI.pm user could I +1 this suggestion. The current doc of query_string is quite misleading. It would also be useful to have raw_query_string to really give the unprocessed query string without poking around in environment variables.
This issue has been copied to: https://github.com/leejo/CGI.pm/issues/58 please take all future correspondence there. This ticket will remain open but please do not reply here. This ticket will be closed when the github issue is dealt with.
perldoc updated, will go out in next release. commit c1eb2f373ecdf4e71361227ead3ce453b5a31501 Author: Lee Johnson <lee@givengain.ch> Date: Thu Jun 12 22:27:18 2014 +0200 resolve #58 [rt.cpan.org #48370] - clarify docs for query_string() method - it does *not* return the unprocessed query string, it returns a *representation* of the query string, so the current perldoc is misleading.