Skip Menu |

This queue is for tickets about the CGI-Application-Plugin-DevPopup-Query CPAN distribution.

Report information
The Basics
Id: 52438
Status: resolved
Worked: 1.2 hours (75 min)
Priority: 0/
Queue: CGI-Application-Plugin-DevPopup-Query

People
Owner: stro [...] cpan.org
Requestors: MARKSTOS [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: Wishlist
Broken in: 1.00
Fixed in: 1.02



Subject: wish: improved documentation
Thanks for contributing this CGI::Application. I would like to see the documentation updated with an example of what it does in the Synopsis (not just how to load it), as well as a description of what it does in a "DESCRIPTION" section. If composing English is an issue, I'm sure some of the people on the CGI::Application mailing list could offer some assistance. The same feedback would apply to "CGI::Application::Plugin::DevPopup::Params". Thanks again for this plugin... I look forward to seeing the next revision! Mark
Hi Mark, On Fri Dec 04 13:34:30 2009, MARKSTOS wrote: Show quoted text
> I would like to see the documentation updated with an example of what it > does in the Synopsis (not just how to load it), as well as a description > of what it does in a "DESCRIPTION" section.
I've added some information about modules usage in 1.01. Not much but there's really not so much to describe. Let me know if you have some suggestions or remarks. -- Serguei Trouchelle
Subject: Re: [rt.cpan.org #52438] wish: improved documentation
Date: Tue, 8 Dec 2009 09:40:08 -0500
To: bug-CGI-Application-Plugin-DevPopup-Query [...] rt.cpan.org
From: Mark Stosberg <mark [...] summersault.com>
On Tue, 08 Dec 2009 07:00:05 -0500 "Serguei Trouchelle via RT" <bug-CGI-Application-Plugin-DevPopup-Query@rt.cpan.org> wrote: Show quoted text
> <URL: https://rt.cpan.org/Ticket/Display.html?id=52438 > > > Hi Mark, > > On Fri Dec 04 13:34:30 2009, MARKSTOS wrote: >
> > I would like to see the documentation updated with an example of what it > > does in the Synopsis (not just how to load it), as well as a description > > of what it does in a "DESCRIPTION" section.
> > I've added some information about modules usage in 1.01. Not much but > there's really not so much to describe. Let me know if you have some > suggestions or remarks.
Thanks. I find that helpful. Where you say: "This section contains a list of CGI query parameters passed to your CGI::Application." I would add *and associated values*: "This section contains a list of CGI query parameters and associated values passed to your CGI::Application." Mark
Thanks, changed in 1.02, which is on its way to CPAN now. On Tue Dec 08 09:40:30 2009, mark@summersault.com wrote: Show quoted text
> Where you say: > > "This section contains a list of CGI query parameters passed to your > CGI::Application." > > I would add *and associated values*: > > "This section contains a list of CGI query parameters and associated > values passed to your CGI::Application."
-- Serguei Trouchelle