diff options
| author | Sean Liao <sean@liao.dev> | 2026-02-07 14:38:05 +0000 |
|---|---|---|
| committer | Sean Liao <sean@liao.dev> | 2026-02-12 12:37:31 -0800 |
| commit | e5df06bc55f18ff92fb1c2fce2af69e80d9b3194 (patch) | |
| tree | 3e12dd5552f3190f95a5a5799518bfe85eb612b3 /src | |
| parent | b464a924a9bdd00627cbc3baca86a0e042fccb8a (diff) | |
| download | go-e5df06bc55f18ff92fb1c2fce2af69e80d9b3194.tar.xz | |
time: document that LoadLocation creates new Location instances
Fixes #77385
Change-Id: I7e7ddb1c71f0aebd893f640d476b273e229b059a
Reviewed-on: https://go-review.googlesource.com/c/go/+/743040
Reviewed-by: Ian Lance Taylor <iant@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Michael Pratt <mpratt@google.com>
Reviewed-by: Junyang Shao <shaojunyang@google.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/time/zoneinfo.go | 9 | ||||
| -rw-r--r-- | src/time/zoneinfo_read.go | 2 |
2 files changed, 6 insertions, 5 deletions
diff --git a/src/time/zoneinfo.go b/src/time/zoneinfo.go index f0444a5d9d..faa5691259 100644 --- a/src/time/zoneinfo.go +++ b/src/time/zoneinfo.go @@ -645,12 +645,13 @@ var errLocation = errors.New("time: invalid location name") var zoneinfo *string var zoneinfoOnce sync.Once -// LoadLocation returns the Location with the given name. +// LoadLocation returns a [Location] with the given name. // -// If the name is "" or "UTC", LoadLocation returns UTC. -// If the name is "Local", LoadLocation returns Local. +// If the name is "" or "UTC", LoadLocation returns [UTC]. +// If the name is "Local", LoadLocation returns [Local]. // -// Otherwise, the name is taken to be a location name corresponding to a file +// Otherwise, a new [Location] is created where the name is taken +// to be a location name corresponding to a file // in the IANA Time Zone database, such as "America/New_York". // // LoadLocation looks for the IANA Time Zone database in the following diff --git a/src/time/zoneinfo_read.go b/src/time/zoneinfo_read.go index 047e360d11..1f134556ec 100644 --- a/src/time/zoneinfo_read.go +++ b/src/time/zoneinfo_read.go @@ -111,7 +111,7 @@ func byteString(p []byte) string { var errBadData = errors.New("malformed time zone information") -// LoadLocationFromTZData returns a Location with the given name +// LoadLocationFromTZData returns a new [Location] with the given name // initialized from the IANA Time Zone database-formatted data. // The data should be in the format of a standard IANA time zone file // (for example, the content of /etc/localtime on Unix systems). |