diff options
| author | Scott Gasch <[email protected]> | 2022-05-31 15:36:40 -0700 |
|---|---|---|
| committer | Scott Gasch <[email protected]> | 2022-05-31 15:36:40 -0700 |
| commit | 02302bbd9363facb59c4df2c1f4013087702cfa6 (patch) | |
| tree | 938e51338678416afc891d2839c2ee8dd341f34d /smart_future.py | |
| parent | f3dbc7dc19ba5703f8f5aa9bf8af3c491b3510f6 (diff) | |
Improve docstrings for sphinx.
Diffstat (limited to 'smart_future.py')
| -rw-r--r-- | smart_future.py | 10 |
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 |