Commit 396afbf7 authored by Miss Islington (bot)'s avatar Miss Islington (bot) Committed by GitHub

Fix docstring of Profiler class (GH-8651)

(cherry picked from commit 2ebd3813)
Co-authored-by: default avatarINADA Naoki <methane@users.noreply.github.com>
parent 24a54da9
...@@ -64,11 +64,11 @@ def help(): ...@@ -64,11 +64,11 @@ def help():
# ____________________________________________________________ # ____________________________________________________________
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).
""" """
......
...@@ -807,11 +807,11 @@ static PyMethodDef profiler_methods[] = { ...@@ -807,11 +807,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\
"); ");
......
Markdown is supported
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