From 1dc17eaf6ed4bb2f2acb99fe7fe1f6857f645cc8 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sun, 10 Nov 2019 16:32:38 -0500 Subject: Finish the sqldata.py docstrings --- coverage/misc.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'coverage/misc.py') 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 -- cgit v1.2.1