From dd05475f480708261835aa5626f55d9a9f4bf2f8 Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Tue, 8 Sep 2020 14:06:20 -0400
Subject: [PATCH] Correct `required_passes` API documentation
---
src/_zkapauthorizer/storage_common.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/_zkapauthorizer/storage_common.py b/src/_zkapauthorizer/storage_common.py
index e30149c..38a46d5 100644
--- a/src/_zkapauthorizer/storage_common.py
+++ b/src/_zkapauthorizer/storage_common.py
@@ -102,8 +102,8 @@ def get_configured_lease_duration(node_config):
def required_passes(bytes_per_pass, share_sizes):
"""
- Calculate the number of passes that are required to store ``stored_bytes``
- for one lease period.
+ Calculate the number of passes that are required to store shares of the
+ given sizes for one lease period.
:param int bytes_per_pass: The number of bytes the storage of which for
one lease period one pass covers.
--
GitLab