Commit 40f3b90c authored by Kirill Smelkov's avatar Kirill Smelkov

sync: Provide package documentation

Briefly describe provided functionality instead of only referring to
https://golang.org/pkg/sync.
parent b06ec3d4
...@@ -19,9 +19,11 @@ ...@@ -19,9 +19,11 @@
# See https://www.nexedi.com/licensing for rationale and options. # See https://www.nexedi.com/licensing for rationale and options.
"""Package sync mirrors Go package sync. """Package sync mirrors Go package sync.
See the following link about Go sync package: - `Once` allows to execute an action only once.
- `WaitGroup` allows to wait for a collection of tasks to finish.
- `Sema` and `Mutex` provide low-level synchronization.
https://golang.org/pkg/sync See also https://golang.org/pkg/sync for Go sync package documentation.
""" """
cdef extern from "golang/libgolang.h" namespace "golang::sync" nogil: cdef extern from "golang/libgolang.h" namespace "golang::sync" nogil:
......
...@@ -17,11 +17,14 @@ ...@@ -17,11 +17,14 @@
# #
# 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 sync mirrors Go package sync. """Package sync mirrors and amends Go package sync.
See the following link about Go sync package: - `WorkGroup` allows to spawn group of goroutines working on a common task.
- `Once` allows to execute an action only once.
- `WaitGroup` allows to wait for a collection of tasks to finish.
- `Sema` and `Mutex` provide low-level synchronization.
https://golang.org/pkg/sync See also https://golang.org/pkg/sync for Go sync package documentation.
""" """
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