summaryrefslogtreecommitdiff
path: root/smart_future.py
diff options
context:
space:
mode:
Diffstat (limited to 'smart_future.py')
-rw-r--r--smart_future.py10
1 files changed, 4 insertions, 6 deletions
diff --git a/smart_future.py b/smart_future.py
index 7768599..dbce432 100644
--- a/smart_future.py
+++ b/smart_future.py
@@ -2,12 +2,10 @@
# © Copyright 2021-2022, Scott Gasch
-"""
-A future that can be treated as a substutute for the result that it
-contains and will not block until it is used. At that point, if the
-underlying value is not yet available yet, it will block until the
-internal result actually becomes available.
-
+"""A :class:Future that can be treated as a substutute for the result
+that it contains and will not block until it is used. At that point,
+if the underlying value is not yet available yet, it will block until
+the internal result actually becomes available.
"""
from __future__ import annotations