Improve docstrings for sphinx.

[python_utils.git] / smart_future.py

diff --git a/smart_future.py b/smart_future.py
index 7768599b419e014375a3750ee592c168e21c123e..dbce4321842995a1855788089f8e598c8ad8bd11 100644 (file)
--- 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