Change docstring for logrun.internals.eval_checksum

Author: dccsillag

docs/logrun/internals.html

@@ -94,7 +94,7 @@ <h1 class="title">Module <code>logrun.internals</code></h1>
 def eval_checksum(path: str, state: Optional[xxhash.xxh3_64] = None, digest: bool = True) \
         -&gt; Optional[str]:
     &#34;&#34;&#34;
-    Evaluates the checksum of a given path (which can be either a file or a directory).
+    Evaluates the checksum of the contents of a given path (which can be either a file or a directory).
     &#34;&#34;&#34;
 
     path = os.path.abspath(os.path.realpath(path))
@@ -399,15 +399,15 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 <span>def <span class="ident">eval_checksum</span></span>(<span>path: str, state: Optional[xxhash.xxh3_64] = None, digest: bool = True) ‑> Optional[str]</span>
 </code></dt>
 <dd>
-<div class="desc"><p>Evaluates the checksum of a given path (which can be either a file or a directory).</p></div>
+<div class="desc"><p>Evaluates the checksum of the contents of a given path (which can be either a file or a directory).</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def eval_checksum(path: str, state: Optional[xxhash.xxh3_64] = None, digest: bool = True) \
         -&gt; Optional[str]:
     &#34;&#34;&#34;
-    Evaluates the checksum of a given path (which can be either a file or a directory).
+    Evaluates the checksum of the contents of a given path (which can be either a file or a directory).
     &#34;&#34;&#34;
 
     path = os.path.abspath(os.path.realpath(path))

logrun/internals.py

@@ -65,7 +65,7 @@ def ensure_dir_exists(path: str) -> str:
 def eval_checksum(path: str, state: Optional[xxhash.xxh3_64] = None, digest: bool = True) \
         -> Optional[str]:
     """
-    Evaluates the checksum of a given path (which can be either a file or a directory).
+    Evaluates the checksum of the contents of a given path (which can be either a file or a directory).
     """
 
     path = os.path.abspath(os.path.realpath(path))