Commit 1de59346 authored by Kirill Smelkov's avatar Kirill Smelkov

fixup! sync: Provide package documentation

This amends commit 40f3b90c: sync.Sema is not provided in Go version.
parent c5c576d2
......@@ -17,13 +17,15 @@
#
# See COPYING file for full licensing terms.
# See https://www.nexedi.com/licensing for rationale and options.
"""Package sync mirrors Go package sync.
"""Package sync mirrors and amends Go package sync.
- `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.
- `Sema`(*) and `Mutex` provide low-level synchronization.
See also https://golang.org/pkg/sync for Go sync package documentation.
(*) not provided in Go version.
"""
cdef extern from "golang/sync.h" namespace "golang::sync" nogil:
......
......@@ -20,11 +20,11 @@
// See COPYING file for full licensing terms.
// See https://www.nexedi.com/licensing for rationale and options.
// Package sync mirrors Go package sync.
// Package sync mirrors and amends Go package sync.
//
// - `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.
// - `Sema`(*) and `Mutex` provide low-level synchronization.
//
// See also https://golang.org/pkg/sync for Go sync package documentation.
//
......@@ -33,7 +33,9 @@
//
// Subset of sync package functionality is also provided via C-level API:
//
// - `_makesema` and `_sema*` provide semaphore functionality.
// - `_makesema` and `_sema*` provide semaphore functionality(*).
//
// (*) not provided in Go version.
#include <golang/libgolang.h>
......
......@@ -22,7 +22,7 @@
- `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.
- `Sema`(*) and `Mutex` provide low-level synchronization.
See also https://golang.org/pkg/sync for Go sync package documentation.
......
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