BIND 10 #2843: isc.statistics.counters.py shouldn't have DNS-specific information

[BIND 10 Development]

#2843: isc.statistics.counters.py shouldn't have DNS-specific information
-------------------------------------+-------------------------------------
            Reporter:  jinmei        |                        Owner:
                Type:  defect        |  vorner
            Priority:  medium        |                       Status:
           Component:  statistics    |  reviewing
            Keywords:                |                    Milestone:
           Sensitive:  0             |  Sprint-20130806
         Sub-Project:  Core          |                   Resolution:
Estimated Difficulty:  2             |                 CVSS Scoring:
         Total Hours:  0             |              Defect Severity:  N/A
                                     |  Feature Depending on Ticket:
                                     |          Add Hours to Ticket:  0
                                     |                    Internal?:  0
-------------------------------------+-------------------------------------
Changes (by naokikambe):

 * owner:  naokikambe => vorner


Comment:

 Hello, thank you for reviewing.

 > First one is, you seem to refer to the `__doc__` elements directly.
 While it is technically true the documentation is stored there, I thought
 python always tried to hide it little bit. Wouldn't it be better to
 reference to other docstrigs as „see documentation for
 isc.statistics.counters“ instead of „see isc.statistics.counters.__doc__“?
 Or, is there any reason to include the `__doc__` there?

 I replaced such uses of `__doc__`. Please see this.
 {{{
 8015b40 [2843] replace __doc__ in documentation with 'documentation for'
 }}}

 >
 > I'm little bit worried about the spec file parameter being optional. For
 one, the general description of both classes says it may be there and how
 it works if it is there, but it doesn't say what happens when the
 parameter is not present. But the bigger problem (which was, arguably, not
 introduced in this ticket) I see is that the hardcoded default is for one
 single module. Is there a reason to have this default? Wouldn't it be
 better the spec file was mandatory?

 I'm going to remove _Statistics() on #2883. So I updated documentation a
 little. Please see
 {{{
 7a6cf13 [2843] update documentation for _Statistics class which will be
 removed
 }}}

 Regards,

-- 
Ticket URL: <http://bind10.isc.org/ticket/2843#comment:11>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development