cybercyst/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-05-05 15:43:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

godoc/vfs: improve comment on GOROOT

Browse Source 
GOROOT is not a function, so use "is" instead of "returns".
This was originally raised during review of golang.org/cl/131315.

Also add a missing period.

Change-Id: Ie28d38529889702ae5035d0f48d8122b6bee6819
Reviewed-on: https://go-review.googlesource.com/131316
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
This commit is contained in:
Agniva De Sarker 2018-08-25 10:22:28 +05:30 committed by Dmitri Shuralyov
parent 6c1c5e93cd
commit b776bcbf45
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
godoc/vfs/os.go
View File

@ -17,9 +17,9 @@ import (
// We expose a new variable because otherwise we need to copy the findGOROOT logic again // We expose a new variable because otherwise we need to copy the findGOROOT logic again
// from cmd/godoc which is already copied twice from the standard library. // from cmd/godoc which is already copied twice from the standard library.
// GOROOT returns the GOROOT path under which the godoc binary is running. // GOROOT is the GOROOT path under which the godoc binary is running.
// It is needed to check whether a filesystem root is under GOROOT or not. // It is needed to check whether a filesystem root is under GOROOT or not.
// This is set from cmd/godoc/main.go // This is set from cmd/godoc/main.go.
var GOROOT = runtime.GOROOT() var GOROOT = runtime.GOROOT()
// OS returns an implementation of FileSystem reading from the // OS returns an implementation of FileSystem reading from the