correct documentation for some Linked List Methods (#23)

Author: Dean Karn

container/list/doubly_linked.go

@@ -106,8 +106,8 @@ func (d *DoublyLinkedList[V]) PushAfter(node *Node[V], v V) *Node[V] {
 
 // MoveAfter moves the `moving` node after the supplied `node`.
 //
-// The supplied `node` must be attached to the current list and the `moving` node must either be attached to the
-// current list or not attached to any other otherwise undefined behaviour could occur.
+// The supplied `node` and `moving` nodes must be attached to the current list otherwise
+// undefined behaviour could occur.
 func (d *DoublyLinkedList[V]) MoveAfter(node *Node[V], moving *Node[V]) {
 	// first detach node were moving after, in case it was already attached somewhere else in the list.
 	d.Remove(moving)
@@ -142,8 +142,8 @@ func (d *DoublyLinkedList[V]) PushBefore(node *Node[V], v V) *Node[V] {
 
 // MoveBefore moves the `moving` node before the supplied `node`.
 //
-// The supplied `node` must be attached to the current list and the `moving` node must either be attached to the
-// current list or not attached to any other otherwise undefined behaviour could occur.
+// The supplied `node` and `moving` nodes must be attached to the current list otherwise
+// undefined behaviour could occur.
 func (d *DoublyLinkedList[V]) MoveBefore(node *Node[V], moving *Node[V]) {
 	// first detach node were moving after, in case it was already attached somewhere else in the list.
 	d.Remove(moving)
@@ -216,12 +216,16 @@ func (d *DoublyLinkedList[V]) Remove(node *Node[V]) {
 }
 
 // MoveToFront moves the provided node to the front/head.
+//
+// The supplied node must be attached to the current list otherwise undefined behaviour could occur.
 func (d *DoublyLinkedList[V]) MoveToFront(node *Node[V]) {
 	d.Remove(node)
 	d.pushFront(node)
 }
 
 // MoveToBack moves the provided node to the end/tail.
+//
+// The supplied node must be attached to the current list otherwise undefined behaviour could occur.
 func (d *DoublyLinkedList[V]) MoveToBack(node *Node[V]) {
 	d.Remove(node)
 	d.pushBack(node)

container/list/doubly_linked_test.go

@@ -368,6 +368,24 @@ func TestLinkedListMoving(t *testing.T) {
 	Equal(t, l.Len(), 0)
 }
 
+func TestLinkedListRemoveSingleEntry(t *testing.T) {
+
+	l := NewDoublyLinked[int]()
+	Equal(t, l.IsEmpty(), true)
+	Equal(t, l.Len(), 0)
+
+	// test pushing after with one node
+	node := l.PushFront(0)
+	Equal(t, l.IsEmpty(), false)
+	Equal(t, l.Len(), 1)
+	Equal(t, l.Front().Value, node.Value)
+	Equal(t, l.Back().Value, node.Value)
+
+	l.Remove(node)
+	Equal(t, l.IsEmpty(), true)
+	Equal(t, l.Len(), 0)
+}
+
 func BenchmarkDoublyLinkedList(b *testing.B) {
 	for i := 0; i < b.N; i++ {
 		l := NewDoublyLinked[int]()