diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2019-11-10 16:32:38 -0500 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2019-11-10 16:32:38 -0500 |
commit | 1dc17eaf6ed4bb2f2acb99fe7fe1f6857f645cc8 (patch) | |
tree | d6f0fa95fb248eb093fd57a0f608f418361644d7 /coverage/misc.py | |
parent | 7cbd4e94bfb8eac5dbeb418bc5b75cffb19db227 (diff) | |
download | python-coveragepy-git-1dc17eaf6ed4bb2f2acb99fe7fe1f6857f645cc8.tar.gz |
Finish the sqldata.py docstrings
Diffstat (limited to 'coverage/misc.py')
-rw-r--r-- | coverage/misc.py | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/coverage/misc.py b/coverage/misc.py index 4ac24ff0..fc2a5c98 100644 --- a/coverage/misc.py +++ b/coverage/misc.py @@ -178,7 +178,15 @@ def output_encoding(outfile=None): def filename_suffix(suffix): - """Compute a filename suffix for a data file.""" + """Compute a filename suffix for a data file. + + If `suffix` is a string or None, simply return it. If `suffix` is True, + then build a suffix incorporating the hostname, process id, and a random + number. + + Returns a string or None. + + """ if suffix is True: # If data_suffix was a simple true value, then make a suffix with # plenty of distinguishing information. We do this here in |