code review 181058: Update documentation around time.Sleep to specify its p...

Update documentation around time.Sleep to specify its precision, and suggest
a possible interface for more granular sleep times.

Fixes issue #260.

[dho, 2009-12-24 21:07:14]

Hello rsc (cc: golang-dev@googlegroups.com),

I'd like you to review the following change.

[r, 2009-12-24 21:09:59]

http://codereview.appspot.com/181058/diff/1001/4
File src/pkg/time/sleep.go (right):

http://codereview.appspot.com/181058/diff/1001/4#newcode13
src/pkg/time/sleep.go:13: // of time slept may vary, the only guarantee made is
that Sleep will not return before
that's what at least means.
the intent is good but this is too much prose.
please shorten it.

[dho, 2009-12-24 21:16:19]

2009/12/24  <r@golang.org>:
>
> http://codereview.appspot.com/181058/diff/1001/4
> File src/pkg/time/sleep.go (right):
>
> http://codereview.appspot.com/181058/diff/1001/4#newcode13
> src/pkg/time/sleep.go:13: // of time slept may vary, the only guarantee
> made is that Sleep will not return before
> that's what at least means.
> the intent is good but this is too much prose.
> please shorten it.

Pardon my verbosity :). PTAL

[r, 2009-12-24 21:19:58]

http://codereview.appspot.com/181058/diff/1004/1005
File src/pkg/time/sleep.go (right):

http://codereview.appspot.com/181058/diff/1004/1005#newcode14
src/pkg/time/sleep.go:14: // It returns os.EINTR if interrupted.
s/It/Sleep/
(the referent is now unclear)

[dho, 2009-12-24 21:22:11]

2009/12/24  <r@golang.org>:
>
> http://codereview.appspot.com/181058/diff/1004/1005
> File src/pkg/time/sleep.go (right):
>
> http://codereview.appspot.com/181058/diff/1004/1005#newcode14
> src/pkg/time/sleep.go:14: // It returns os.EINTR if interrupted.
> s/It/Sleep/
> (the referent is now unclear)

Good call. PTAL.

[r, 2009-12-24 21:23:38]

LGTM

[r, 2009-12-24 21:24:05]

*** Submitted as http://code.google.com/p/go/source/detail?r=16355a0398ab ***

Update documentation around time.Sleep to specify its precision, and suggest
a possible interface for more granular sleep times.

Fixes issue #260.

R=rsc, r
CC=golang-dev
http://codereview.appspot.com/181058

Committer: Rob Pike <r@golang.org>