Skip Menu |

This queue is for tickets about the Zenoss CPAN distribution.

Report information
The Basics
Id: 70143
Status: resolved
Priority: 0/
Queue: Zenoss
People
Owner: patricksbaker [...] gmail.com
Requestors: agarcia [...] experts-exchange.com
Cc:
AdminCc:
Bug Information
Severity: Normal
Broken in: 1.08
Fixed in: 1.10

History Show all quoted text
  Mon Aug 08 12:33:43 2011 agarcia [...] experts-exchange.com - Ticket created
Subject: Documentation
Two issues I found with the documentation are: *The use of the word dictionary instead of hash for return values can be misleading for those not familiar with python. *Missing documentation for getInfo() method under the Zenoss::Devices module. Great job on this again. Looking forward to using it.
  Sun Aug 14 14:08:19 2011 patricksbaker [...] gmail.com - Taken
  Sun Aug 14 14:23:58 2011 patricksbaker [...] gmail.com - Correspondence added
On Mon Aug 08 12:33:43 2011, agarcia wrote:
Show quoted text
> Two issues I found with the documentation are:
>
> *The use of the word dictionary instead of hash for return values can be
> misleading for those not familiar with python.
>

In review of this, I've decided not to adjust the use of dictionaries.  In the main module documentation, I specifically placed a disclaimer advising the reader of such usage.

"The documentation for these modules was mostly taken from the Zenoss JSON API docs.  Keep in mind
that their (Zenoss Monitoring System) programming is based around python, so descriptions such as
dictionaries will be represented as hashes in Perl."

Continued use of this paradigm will allow me to focus on keeping documentation in sync and less about editing / translating.


Show quoted text
> *Missing documentation for getInfo() method under the Zenoss::Devices
> module.
>
> Great job on this again. Looking forward to using it.
>
Documentation has been added and will be included in version 1.09
  Sun Aug 14 14:23:59 2011 The RT System itself - Status changed from 'new' to 'open'
  Sun Aug 14 16:58:46 2011 patricksbaker [...] gmail.com - Correspondence added
In the spirit of better documentation, I've added the following disclaimer to each Router module.

The documentation for this module was mostly taken from the Zenoss JSON API docs.  Keep in mind
that their (Zenoss Monitoring System) programming is based around python, so descriptions such as
dictionaries will be represented as hashes in Perl.

  Mon Aug 15 10:16:58 2011 patricksbaker [...] gmail.com - Fixed in 1.10 added
  Mon Aug 15 10:19:36 2011 patricksbaker [...] gmail.com - Correspondence added
 This has been implemented in version 1.10, which is now available on CPAN.
  Mon Aug 15 10:19:37 2011 patricksbaker [...] gmail.com - Status changed from 'open' to 'resolved'