Bug #48274 for WWW-Salesforce: describeGlobal() docs are insufficient

Tue Jul 28 14:09:56 2009 MARKSTOS [...] cpan.org - Ticket created

Subject:

describeGlobal() docs are insufficient

"describeGlobal()" is currently documented like this: "Retrieves a list of available objects for your organization's data." I tried calling it and running the result through "Data::Dumper", and I got pages and pages of output. The docs for describeGlobal() should detail what kind of objects can possibly be returned here, so I have an idea of what kinds of methods are available to call on them. ( An unrelated tip: switching the method names from "=item" to "=head3" will make them show up in the Table of Contents that CPAN auto-generates, making it easier to browse the docs online. For example, you see where this has been done with CGI::Application: http://search.cpan.org/~markstos/CGI-Application-4.21/lib/CGI/Application.pm ) Thanks again for your help with this module! Mark

Fri Sep 18 10:28:38 2009 cwhitener [...] gmail.com - Taken

Fri Sep 18 10:29:54 2009 cwhitener [...] gmail.com - Correspondence added

Hi Mark, With the new module in the works, documentation is going to be a major part of the rewrite. As far as your suggestions for changes in the POD layout, thanks, I've started using them in the new documentation. Thanks, Chase

Fri Sep 18 10:29:55 2009 The RT System itself - Status changed from 'new' to 'open'

Tue Aug 17 21:06:09 2010 PHRED [...] cpan.org - Correspondence added

Mark if you have a patch I'd be much obliged. Probably be shipping 0.12 today but we can push out another revision.

Wed Aug 18 09:59:07 2010 MARKSTOS [...] cpan.org - Correspondence added

On Tue Aug 17 21:06:09 2010, PHRED wrote: Show quoted text

> Mark if you have a patch I'd be much obliged. Probably be shipping > 0.12 today but we can push > out another revision.

I'm glad to see this module is seeing maintenance again. Thanks! We evaluated the module but never used it. I've lost context on it now and don't use it personally, so I won't be the person to follow up on this soon.

Tue Jul 28 16:26:44 2015 cwhitener [...] gmail.com - Correspondence added

Hi Mark, The lack of documentation has been fixed in a branch that I'll forward onto Fred for his next release. The other mentioned documentation updates were implemented as well. Thanks, Chase

Tue Jul 28 16:26:46 2015 cwhitener [...] gmail.com - Status changed from 'open' to 'resolved'