Browse Source

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

Naoki Kambe 11 years ago
parent
commit
7a6cf1357a
2 changed files with 6 additions and 3 deletions
  1. 4 2
      src/lib/python/isc/statistics/counters.py
  2. 2 1
      src/lib/python/isc/statistics/dns.py

+ 4 - 2
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 = {}

+ 2 - 1
src/lib/python/isc/statistics/dns.py

@@ -70,7 +70,8 @@ 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