From 02302bbd9363facb59c4df2c1f4013087702cfa6 Mon Sep 17 00:00:00 2001 From: Scott Gasch Date: Tue, 31 May 2022 15:36:40 -0700 Subject: Improve docstrings for sphinx. --- smart_future.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'smart_future.py') 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 -- cgit v1.3