[tor-commits] [chutney/master] TorNet: document updateLastOnionServiceDescStatus

[nickm at torproject.org]

commit 3635be7b0186cd7ca340a965bae7098237a07e01
Author: c <c at chroniko.jp>
Date:   Thu May 21 07:52:24 2020 +0000

    TorNet: document updateLastOnionServiceDescStatus
    
    Update updateLastOnionServiceDescStatus and
    getLastOnionServiceDescStatus docstrings
---
 lib/chutney/TorNet.py | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/lib/chutney/TorNet.py b/lib/chutney/TorNet.py
index b211fc2..76512ab 100644
--- a/lib/chutney/TorNet.py
+++ b/lib/chutney/TorNet.py
@@ -1161,6 +1161,9 @@ class LocalNodeController(NodeController):
     HSV3_KEYWORD = "hidden service v3"
 
     def updateLastOnionServiceDescStatus(self):
+        """Look through the logs and cache the last onion service
+           descriptor status received.
+        """
         logfname = self.getLogfile(info=True)
         if not os.path.exists(logfname):
             return (LocalNodeController.MISSING_FILE_CODE,
@@ -1188,9 +1191,9 @@ class LocalNodeController(NodeController):
         self.most_recent_oniondesc_status = (percent, keyword, message)
 
     def getLastOnionServiceDescStatus(self):
-        """Look through info-level logs for onion service descriptor uploads
-           and return a 3-tuple of percentage complete, the hidden service
-           version, and message.
+        """Return the last onion descriptor message fetched by
+           updateLastOnionServiceDescStatus as a 3-tuple of percentage
+           complete, the hidden service version, and message.
         """
         return self.most_recent_oniondesc_status