From: Brad Fitzpatrick <bradfitz@golang.org>
Date: Tue, 20 Mar 2012 18:40:41 +0000 (-0700)
Subject: sort: document two undocumented functions
X-Git-Tag: weekly.2012-03-22~28
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=65dc7dc90bece08e9810de12acf06f82cc6a6384;p=gostls13.git

sort: document two undocumented functions

They looked out of place in godoc.
Includes documenting sort stability.

Fixes #3356

R=golang-dev, gri, trolleriprofessorn
CC=golang-dev
https://golang.org/cl/5855044
---

diff --git a/src/pkg/sort/sort.go b/src/pkg/sort/sort.go
index 31da3c83d0..60f2d9ab40 100644
--- a/src/pkg/sort/sort.go
+++ b/src/pkg/sort/sort.go
@@ -183,6 +183,8 @@ func quickSort(data Interface, a, b, maxDepth int) {
 	}
 }
 
+// Sort sorts data.
+// The algorithm used is not guaranteed to be a stable sort.
 func Sort(data Interface) {
 	// Switch to heapsort if depth of 2*ceil(lg(n)) is reached.
 	n := data.Len()
@@ -194,6 +196,7 @@ func Sort(data Interface) {
 	quickSort(data, 0, n, maxDepth)
 }
 
+// IsSorted reports whether data is sorted.
 func IsSorted(data Interface) bool {
 	n := data.Len()
 	for i := n - 1; i > 0; i-- {