Commit 4ab7d17e authored by Naoki Kambe's avatar Naoki Kambe
Browse files

[917] add more docstrings to the functions get_stats_data and get_stats_spec

parent df02b63f
......@@ -369,7 +369,15 @@ class StatsHttpd:
def get_stats_data(self, owner=None, name=None):
"""Requests statistics data to the Stats daemon and returns
the data which obtains from it. args are owner and name."""
the data which obtains from it. The first argument is the
module name which owns the statistics data, the second
argument is one name of the statistics items which the the
module owns. The second argument cannot be specified when the
first argument is not specified. It returns the statistics
data of the specified module or item. When the session timeout
or the session error is occurred, it raises
StatsHttpdError. When the stats daemon returns none-zero
value, it raises StatsHttpdDataError."""
param = {}
if owner is None and name is None:
param = None
......@@ -395,7 +403,15 @@ class StatsHttpd:
def get_stats_spec(self, owner=None, name=None):
"""Requests statistics data to the Stats daemon and returns
the data which obtains from it. args are owner and name."""
the data which obtains from it. The first argument is the
module name which owns the statistics data, the second
argument is one name of the statistics items which the the
module owns. The second argument cannot be specified when the
first argument is not specified. It returns the statistics
specification of the specified module or item. When the
session timeout or the session error is occurred, it raises
StatsHttpdError. When the stats daemon returns none-zero
value, it raises StatsHttpdDataError."""
param = {}
if owner is None and name is None:
param = None
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment