Skip to content

Commit b85200c

Browse files
committed
Add package docstrings
1 parent 573e0a4 commit b85200c

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

list/persistent.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ See the License for the specific language governing permissions and
1414
limitations under the License.
1515
*/
1616

17+
/*
18+
Package list provides list implementations. Currently, this includes a
19+
persistent, immutable linked list.
20+
*/
1721
package list
1822

1923
import "errors"

trie/ctrie/ctrie.go

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ See the License for the specific language governing permissions and
1414
limitations under the License.
1515
*/
1616

17+
/*
18+
Package ctrie provides an implementation of the Ctrie data structure, which is
19+
a concurrent, lock-free hash trie. This data structure was originally presented
20+
in the paper Concurrent Tries with Efficient Non-Blocking Snapshots:
21+
22+
https://axel22.github.io/resources/docs/ctries-snapshot.pdf
23+
24+
TODO: Add snapshot support.
25+
*/
1726
package ctrie
1827

1928
import (

0 commit comments

Comments
 (0)