[tor-commits] [sbws/master] Add docstring in generator_started_from_file()

[pastly at torproject.org]

commit 5e596b71e57138fff48d524dbec0f43c1e6eb614
Author: Matt Traudt <sirmatt at ksu.edu>
Date:   Mon Jul 23 13:59:17 2018 -0400

    Add docstring in generator_started_from_file()
---
 sbws/lib/v3bwfile.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/sbws/lib/v3bwfile.py b/sbws/lib/v3bwfile.py
index 2784c2f..54ec98a 100644
--- a/sbws/lib/v3bwfile.py
+++ b/sbws/lib/v3bwfile.py
@@ -190,6 +190,10 @@ class V3BWHeader(object):
 
     @staticmethod
     def generator_started_from_file(conf):
+        '''
+        ISO formatted timestamp for the time when the scanner process most
+        recently started.
+        '''
         state = State(conf['paths']['state_fname'])
         if 'scanner_started' in state:
             return state['scanner_started']