Commit 9216e2db authored by Kirill Smelkov's avatar Kirill Smelkov

context: Provide package documentation

Briefly describe provided functionality instead of only referring to
https://golang.org/pkg/context and https://blog.golang.org/context.
parent b2253abf
...@@ -18,13 +18,7 @@ ...@@ -18,13 +18,7 @@
# #
# See COPYING file for full licensing terms. # See COPYING file for full licensing terms.
# See https://www.nexedi.com/licensing for rationale and options. # See https://www.nexedi.com/licensing for rationale and options.
"""Package context mirrors Go package context. """_context.pyx implements context.py - see context.py for package overview."""
See the following links about Go contexts:
https://blog.golang.org/context
https://golang.org/pkg/context
"""
from __future__ import print_function, absolute_import from __future__ import print_function, absolute_import
......
...@@ -17,12 +17,21 @@ ...@@ -17,12 +17,21 @@
# #
# See COPYING file for full licensing terms. # See COPYING file for full licensing terms.
# See https://www.nexedi.com/licensing for rationale and options. # See https://www.nexedi.com/licensing for rationale and options.
"""Package context mirrors Go package context. """Package context mirrors and amends Go package context.
See the following links about Go contexts: - `Context` represents operational context that carries deadline, cancellation
signal and immutable context-local key -> value dict.
- `background` returns empty context that is never canceled.
- `with_cancel` creates new context that can be canceled on its own.
- `with_deadline` creates new context with deadline.
- `with_timeout` creates new context with timeout.
- `with_value` creates new context with attached key=value.
- `merge` creates new context from 2 parents(*).
https://blog.golang.org/context See also https://golang.org/pkg/context for Go context package documentation.
https://golang.org/pkg/context See also https://blog.golang.org/context for overview.
(*) not provided in Go version.
""" """
from __future__ import print_function, absolute_import from __future__ import print_function, absolute_import
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment