From: qmuntal <quimmuntal@gmail.com>
Date: Mon, 31 Jul 2023 09:00:40 +0000 (+0200)
Subject: time: mention time resolution in docs
X-Git-Tag: go1.22rc1~1464
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=913874367959f4f18a0299c91593c841e91b6808;p=gostls13.git

time: mention time resolution in docs

Updates #44343
Updates #53824

Change-Id: Ia7234fac4b1b88b3c331328aaa98dc85205e09ba
Reviewed-on: https://go-review.googlesource.com/c/go/+/514275
Reviewed-by: David Chase <drchase@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Run-TryBot: Quim Muntal <quimmuntal@gmail.com>
---

diff --git a/src/time/time.go b/src/time/time.go
index e8aac5999a..26872b1c05 100644
--- a/src/time/time.go
+++ b/src/time/time.go
@@ -76,6 +76,16 @@
 // For debugging, the result of t.String does include the monotonic
 // clock reading if present. If t != u because of different monotonic clock readings,
 // that difference will be visible when printing t.String() and u.String().
+//
+// # Timer Resolution
+//
+// Timer resolution varies depending on the Go runtime, the operating system
+// and the underlying hardware.
+// On Unix, the resolution is approximately 1ms.
+// On Windows, the default resolution is approximately 16ms, but
+// a lower resolution may be requested using [timeBeginPeriod].
+//
+// [timeBeginPeriod]: https://learn.microsoft.com/en-us/windows/win32/api/timeapi/nf-timeapi-timebeginperiod
 package time
 
 import (