Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

time: NewTicker is missing documentation on initial tick #42245

Closed
JensRantil opened this issue Oct 28, 2020 · 1 comment
Closed

time: NewTicker is missing documentation on initial tick #42245

JensRantil opened this issue Oct 28, 2020 · 1 comment
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Go1.16

Comments

@JensRantil
Copy link

What version of Go are you using (go version)?

1.15

What did you do?

I was about to use https://golang.org/pkg/time/#Tick and wanted to know if I would get an initial tick or the first tick will be sent immediately or after d time.Duration. https://golang.org/pkg/time/#Tick refers to https://golang.org/pkg/time/#NewTicker so I opened up the documentation for that. I noticed that https://golang.org/pkg/time/#NewTicker doesn't document whether the initial tick is sent immediately or after d time.Duration.

What did you expect to see?

That https://golang.org/pkg/time/#NewTicker documents this behaviour.

What did you see instead?

Behaviour wasn't documented.
@ALTree ALTree changed the title time.NewTicker is missing documentation on initial tick time: NewTicker is missing documentation on initial tick Oct 28, 2020
@gopherbot
Copy link

Change https://golang.org/cl/265818 mentions this issue: time: in NewTicker, document that the 1st tick comes after d

@dmitshur dmitshur added the NeedsFix The path to resolution is known, but the work has not been done. label Oct 30, 2020
@dmitshur dmitshur added this to the Go1.16 milestone Oct 30, 2020
@golang golang locked and limited conversation to collaborators Nov 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Go1.16
Development

No branches or pull requests
3 participants
@JensRantil @dmitshur @gopherbot