BIND 10 trac2843, updated. 7a6cf1357a4c85a794388475ddfcde9ff92cb6ea [2843] update documentation for _Statistics class which will be removed

[BIND 10 source code commits]

The branch, trac2843 has been updated
       via  7a6cf1357a4c85a794388475ddfcde9ff92cb6ea (commit)
       via  8015b408d16d9d5e69c678a1201a9ec0649697a5 (commit)
      from  42407bf17bcaad492cfb9264dd713ad0e0c4f84c (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 7a6cf1357a4c85a794388475ddfcde9ff92cb6ea
Author: Naoki Kambe <kambe at jprs.co.jp>
Date:   Fri Jul 26 17:14:41 2013 +0900

    [2843] update documentation for _Statistics class which will be removed

commit 8015b408d16d9d5e69c678a1201a9ec0649697a5
Author: Naoki Kambe <kambe at jprs.co.jp>
Date:   Fri Jul 26 16:44:37 2013 +0900

    [2843] replace __doc__ in documentation with 'documentation for'
    
    not to refer directly to the hidden element of python

-----------------------------------------------------------------------

Summary of changes:
 src/lib/python/isc/statistics/counters.py |    6 ++++--
 src/lib/python/isc/statistics/dns.py      |   12 +++++++-----
 2 files changed, 11 insertions(+), 7 deletions(-)

-----------------------------------------------------------------------
diff --git a/src/lib/python/isc/statistics/counters.py b/src/lib/python/isc/statistics/counters.py
index fc5d763..87355be 100644
--- a/src/lib/python/isc/statistics/counters.py
+++ b/src/lib/python/isc/statistics/counters.py
@@ -152,7 +152,8 @@ def _concat(*args, sep='/'):
     return sep.join(args)
 
 class _Statistics():
-    """Statistics data set"""
+    """Statistics data set. This class will be remove in the future
+    release."""
     # default statistics data
     _data = {}
     # default statistics spec used in case the specfile is omitted when
@@ -182,7 +183,8 @@ class Counters():
         statistics spec can be accumulated if spec_file_name is
         specified. If omitted, a default statistics spec is used. The
         default statistics spec is defined in a hidden class named
-        _Statistics().
+        _Statistics(). But the hidden class won't be used and
+        spec_file_name will be required in the future release.
         """
         self._zones_item_list = []
         self._start_time = {}
diff --git a/src/lib/python/isc/statistics/dns.py b/src/lib/python/isc/statistics/dns.py
index b5cdcf0..c224687 100644
--- a/src/lib/python/isc/statistics/dns.py
+++ b/src/lib/python/isc/statistics/dns.py
@@ -64,13 +64,14 @@ isc.notify.notify_out, in this example, empty methods would be invoked,
 which is directly defined in `counter.py`.
 
 This module basically inherits isc.statistics.counters.  Also see
-isc.statistics.counters.__doc__ for details."""
+documentation for isc.statistics.counters for details."""
 
 import isc.config
 from isc.statistics import counters
 
 class _Statistics():
-    """Statistics data set"""
+    """Statistics data set. This class will be removed in the future
+    release."""
     # default statistics data
     _data = {}
     # default statistics spec used in case the specfile is omitted when
@@ -127,7 +128,8 @@ class _Statistics():
 
 class Counters(counters.Counters):
     """A list of counters which can be handled in the class are like
-    the following. Also see counters.Counters.__doc__ for details.
+    the following. Also see documentation for
+    isc.statistics.counters.Counters for details.
 
         zones/IN/example.com./notifyoutv4
         zones/IN/example.com./notifyoutv6
@@ -180,8 +182,8 @@ class Counters(counters.Counters):
     def __init__(self, spec_file_name=None):
         """If the item `zones` is defined in the spec file, it obtains a
         list of counter names under it when initiating.  For behaviors
-        other than this, see
-        isc.statistics.counters.Counters.__init__.__doc__."""
+        other than this, see documentation for
+        isc.statistics.counters.Counters.__init__()"""
         counters.Counters.__init__(self, spec_file_name)
         if self._perzone_prefix in \
                 isc.config.spec_name_list(self._statistics._spec):