Skip to content

Commit

Permalink
Fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
mpage committed Jan 27, 2025
1 parent c6cabd8 commit 6e7a48d
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions pyperf/_hooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,12 +119,13 @@ class perf_record(HookBase):
"""Profile the benchmark using perf-record.
Profile data is written to the current directory directory by default, or
the `PYPERF_PERF_RECORD_DATA_DIR` environment if it is provided.
to the value of the `PYPERF_PERF_RECORD_DATA_DIR` environment variable, if
it is provided.
Profile data files have a basename of the form `perf.data.<uuid>`
The value of the `PYPERF_PERF_RECORD_EXTRA_OPTS` is appended to the command line
of perf-record, if provided.
The value of the `PYPERF_PERF_RECORD_EXTRA_OPTS` environment variable is
appended to the command line of perf-record, if provided.
"""

def mkfifo(self, tmpdir, basename):
Expand Down

0 comments on commit 6e7a48d

Please sign in to comment.