1
0
mirror of https://github.com/golang/go synced 2024-10-04 12:21:26 -06:00
go/src/pkg/sort
Rob Pike abe384f68a all: be more idiomatic when documenting boolean return values.
Phrases like "returns whether or not the image is opaque" could be
describing what the function does (it always returns, regardless of
the opacity) or what it returns (a boolean indicating the opacity).
Even when the "or not" is missing, the phrasing is bizarre.

Go with "reports whether", which is still clunky but at least makes
it clear we're talking about the return value.

These were edited by hand. A few were cleaned up in other ways.

R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/11699043
2013-07-23 11:59:49 +10:00
..
example_interface_test.go sort: add interface examples 2012-02-16 13:16:07 +11:00
example_keys_test.go sort: use proper mass unit in example 2013-02-27 10:44:50 -08:00
example_multi_test.go sort: be consistent when describing "less: function in the multiKeys example 2013-04-02 10:25:02 -07:00
example_test.go sort: add Reverse as a function 2013-02-01 08:44:45 -08:00
export_test.go sort: use heapsort to bail out quicksort 2011-09-07 13:54:33 -04:00
search_test.go all: Skip AllocsPerRun tests if GOMAXPROCS>1. 2013-03-06 15:52:32 -08:00
search.go sort: fix comment for various Search routines 2012-11-07 05:07:46 +08:00
sort_test.go sort: fix 32-bit build 2013-07-01 21:44:14 -04:00
sort.go all: be more idiomatic when documenting boolean return values. 2013-07-23 11:59:49 +10:00