From bd99060a93d22e74ebfc5881e7f3b37a0b83fbc3 Mon Sep 17 00:00:00 2001 From: emirpasic Date: Fri, 21 Sep 2018 02:43:37 +0200 Subject: [PATCH] - update comments and documentation --- README.md | 10 +++++----- sets/linkedhashset/linkedhashset.go | 4 +++- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9c1dd32..3816525 100644 --- a/README.md +++ b/README.md @@ -63,22 +63,22 @@ Containers are either ordered or unordered. All ordered containers provide [stat | **Data** | **Structure** | **Ordered** | **[Iterator](#iterator)** | **[Enumerable](#enumerable)** | **Referenced by** | | :--- | :--- | :---: | :---: | :---: | :---: | -| **[Lists](#lists)** | +| [Lists](#lists) | | | [ArrayList](#arraylist) | yes | yes* | yes | index | | | [SinglyLinkedList](#singlylinkedlist) | yes | yes | yes | index | | | [DoublyLinkedList](#doublylinkedlist) | yes | yes* | yes | index | -| **[Sets](#sets)** | +| [Sets](#sets) | | | [HashSet](#hashset) | no | no | no | index | | | [TreeSet](#treeset) | yes | yes* | yes | index | | | [LinkedHashSet](#linkedhashset) | yes | yes* | yes | index | -| **[Stacks](#stacks)** | +| [Stacks](#stacks) | | | [LinkedListStack](#linkedliststack) | yes | yes | no | index | | | [ArrayStack](#arraystack) | yes | yes* | no | index | -| **[Maps](#maps)** | +| [Maps](#maps) | | | [HashMap](#hashmap) | no | no | no | key | | | [TreeMap](#treemap) | yes | yes* | yes | key | | | [HashBidiMap](#hashbidimap) | no | no | no | key* | -| **[Trees](#trees)** | +| [Trees](#trees) | | | [TreeBidiMap](#treebidimap) | yes | yes* | yes | key* | | | [RedBlackTree](#redblacktree) | yes | yes* | no | key | | | [AVLTree](#avltree) | yes | yes* | no | key | diff --git a/sets/linkedhashset/linkedhashset.go b/sets/linkedhashset/linkedhashset.go index 6bce5f6..234fe46 100644 --- a/sets/linkedhashset/linkedhashset.go +++ b/sets/linkedhashset/linkedhashset.go @@ -2,7 +2,9 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. -// Package linkedhashset implements a set that preserves insertion-order and is backed a hash tables to store values and doubly-linked list to store ordering. +// Package linkedhashset is a set that preserves insertion-order. +// +// It is backed by a hash table to store values and doubly-linked list to store ordering. // // Note that insertion-order is not affected if an element is re-inserted into the set. //