Skip Menu |

This queue is for tickets about the DBedit CPAN distribution.

Report information
The Basics
Id: 2647
Status: new
Priority: 0/
Queue: DBedit
People
Owner: Nobody in particular
Requestors: mark [...] summersault.com
Cc:
AdminCc:
Bug Information
Severity: Normal
Broken in: (no value)
Fixed in: (no value)

History Show all quoted text
  Sun May 25 21:14:07 2003 MARKSTOS [...] cpan.org - Ticket created
Subject: documentation needed
There is not sufficient documentation to clearly understand what the module is doing and how to use it. Also, the README file should be updated to reflect the state of the module. Currently it appears a boilerplate h2xs file is in there. It's probably also the case that the modules in this distribution shouldn't be using a top-level name space. Did you discuss the names with modules@perl.org first, as described here? http://www.cpan.org/modules/04pause.html#namespace Probably something beneath one of the existing top level database prefixes is more appropriate.
  Mon May 26 15:20:07 2003 gna [...] gnacademy.org - Correspondence added
Thanks for the feedback. This is basically an internal module for http://www.gnacademy.org that we released with the minimal amount of first pass documentation. We'll improve the documentation and change the name space over the next few months. [MARKSTOS - Sun May 25 21:14:07 2003]: Show quoted text
> There is not sufficient documentation to clearly understand what the > module is doing and how to use it. Also, the README file should be > updated to reflect the state of the module. Currently it appears a > boilerplate h2xs file is in there. > > It's probably also the case that the modules in this distribution > shouldn't be using a top-level name space. Did you discuss the > names with modules@perl.org first, as described here? > > http://www.cpan.org/modules/04pause.html#namespace > > Probably something beneath one of the existing top level database > prefixes is more appropriate. >