From b776bcbf45cd3a7a25b056cb456aae1d27f0cdf9 Mon Sep 17 00:00:00 2001 From: Agniva De Sarker Date: Sat, 25 Aug 2018 10:22:28 +0530 Subject: [PATCH] godoc/vfs: improve comment on GOROOT 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 --- godoc/vfs/os.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/godoc/vfs/os.go b/godoc/vfs/os.go index 637d65fd..35d05094 100644 --- a/godoc/vfs/os.go +++ b/godoc/vfs/os.go @@ -17,9 +17,9 @@ import ( // 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. -// 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. -// This is set from cmd/godoc/main.go +// This is set from cmd/godoc/main.go. var GOROOT = runtime.GOROOT() // OS returns an implementation of FileSystem reading from the