Fix docstring of Profiler class (GH-8651)
This commit is contained in:
parent
b6efc2cf97
commit
2ebd3813af
|
@ -25,11 +25,11 @@ runctx.__doc__ = _pyprofile.runctx.__doc__
|
||||||
# ____________________________________________________________
|
# ____________________________________________________________
|
||||||
|
|
||||||
class Profile(_lsprof.Profiler):
|
class Profile(_lsprof.Profiler):
|
||||||
"""Profile(custom_timer=None, time_unit=None, subcalls=True, builtins=True)
|
"""Profile(timer=None, timeunit=None, subcalls=True, builtins=True)
|
||||||
|
|
||||||
Builds a profiler object using the specified timer function.
|
Builds a profiler object using the specified timer function.
|
||||||
The default timer is a fast built-in one based on real time.
|
The default timer is a fast built-in one based on real time.
|
||||||
For custom timer functions returning integers, time_unit can
|
For custom timer functions returning integers, timeunit can
|
||||||
be a float specifying a scale (i.e. how long each integer unit
|
be a float specifying a scale (i.e. how long each integer unit
|
||||||
is, in seconds).
|
is, in seconds).
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -788,11 +788,11 @@ static PyMethodDef profiler_methods[] = {
|
||||||
};
|
};
|
||||||
|
|
||||||
PyDoc_STRVAR(profiler_doc, "\
|
PyDoc_STRVAR(profiler_doc, "\
|
||||||
Profiler(custom_timer=None, time_unit=None, subcalls=True, builtins=True)\n\
|
Profiler(timer=None, timeunit=None, subcalls=True, builtins=True)\n\
|
||||||
\n\
|
\n\
|
||||||
Builds a profiler object using the specified timer function.\n\
|
Builds a profiler object using the specified timer function.\n\
|
||||||
The default timer is a fast built-in one based on real time.\n\
|
The default timer is a fast built-in one based on real time.\n\
|
||||||
For custom timer functions returning integers, time_unit can\n\
|
For custom timer functions returning integers, timeunit can\n\
|
||||||
be a float specifying a scale (i.e. how long each integer unit\n\
|
be a float specifying a scale (i.e. how long each integer unit\n\
|
||||||
is, in seconds).\n\
|
is, in seconds).\n\
|
||||||
");
|
");
|
||||||
|
|
Loading…
Reference in New Issue