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.

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

doc: "Named result parameters" section in effective_go.html is less clear than Go specification #42050

Open
boguslaw-wojcik opened this issue Oct 18, 2020 · 1 comment
Open

doc: "Named result parameters" section in effective_go.html is less clear than Go specification #42050

boguslaw-wojcik opened this issue Oct 18, 2020 · 1 comment
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone
Backlog

Comments

@boguslaw-wojcik
Copy link

boguslaw-wojcik commented Oct 18, 2020 •
edited by davecheney

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

$ go version
go version go1.15.3 darwin/amd64

Does this issue reproduce with the latest release?

Yes.

What operating system and processor architecture are you using (go env)?

go env Output
$ go env
GO111MODULE=""
GOARCH="amd64"
GOBIN=""
GOCACHE="/Users/boguslawwojcik/Library/Caches/go-build"
GOENV="/Users/boguslawwojcik/Library/Application Support/go/env"
GOEXE=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="darwin"
GOINSECURE=""
GOMODCACHE="/Users/boguslawwojcik/go/pkg/mod"
GONOPROXY=""
GONOSUMDB=""
GOOS="darwin"
GOPATH="/Users/boguslawwojcik/go"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/usr/local/Cellar/go/1.15.3/libexec"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/usr/local/Cellar/go/1.15.3/libexec/pkg/tool/darwin_amd64"
GCCGO="gccgo"
AR="ar"
CC="clang"
CXX="clang++"
CGO_ENABLED="1"
GOMOD=""
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -fdebug-prefix-map=/var/folders/02/6gpzvgbx5pq4rl60g0spdbvw0000gn/T/go-build215540397=/tmp/go-build -gno-record-gcc-switches -fno-common"

What did you do?

Run following code

package main

import (
	"fmt"
	"time"
)

func main() {
	val := foo()
	fmt.Printf("Main: %+v\n", val.Bar) // explicit
	time.Sleep(2 * time.Second)
}

type Foo struct {
	Bar string
}

func foo() (val *Foo) {
	val = &Foo{Bar: "named"}
	go func() {
		time.Sleep(time.Second)
		fmt.Printf("Goroutine: %+v\n", val.Bar) // explicit
	}()

	val2 := &Foo{Bar: "explicit"}

	return val2
}

What did you expect to see?

Main: explicit Goroutine: named

What did you see instead?

Main: explicit Goroutine: explicit

While I expect this is intended albeit slightly unintuitive behavior, the documentation says named results are initialized and tied to an unadorned return which presupposes that an explicit return is not tied. I humbly propose to alter the documentation to better reflect the actual behavior.
@go101
Copy link

go101 commented Oct 18, 2020

The spec explains it clearer: https://golang.org/ref/spec#Return_statements

@dmitshur dmitshur changed the title Doc: Explicit return in a named return function is written to preinitialized named results doc: "Named result parameters" section in effective_go.html is less clear than Go specification Oct 26, 2020
@dmitshur dmitshur added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Oct 26, 2020
@dmitshur dmitshur added this to the Backlog milestone Oct 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
4 participants
@dmitshur @gopherbot @go101 @boguslaw-wojcik