From e7abfedfabcfcc6a3220ae994ab001754cf1a76a Mon Sep 17 00:00:00 2001 From: Dmitri Shuralyov Date: Mon, 23 Sep 2019 10:59:13 -0400 Subject: [PATCH] godoc, godoc/vfs: improve documentation of GetPageInfo, hasPathPrefix Change GetPageInfo method documentation to match the method name. Prefer using "reports whether" in a function that returns a boolean. This style is more idiomatic. Updates golang/go#33655 Change-Id: I1a781e7b4f5b4b629fdf4f48e2e97183f63508f9 Reviewed-on: https://go-review.googlesource.com/c/tools/+/196977 Reviewed-by: Agniva De Sarker --- godoc/server.go | 2 +- godoc/vfs/namespace.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/godoc/server.go b/godoc/server.go index 693599b4d..17514418c 100644 --- a/godoc/server.go +++ b/godoc/server.go @@ -47,7 +47,7 @@ func (s *handlerServer) registerWithMux(mux *http.ServeMux) { mux.Handle(s.pattern, s) } -// getPageInfo returns the PageInfo for a package directory abspath. If the +// GetPageInfo returns the PageInfo for a package directory abspath. If the // parameter genAST is set, an AST containing only the package exports is // computed (PageInfo.PAst), otherwise package documentation (PageInfo.Doc) // is extracted from the AST. If there is no corresponding package in the diff --git a/godoc/vfs/namespace.go b/godoc/vfs/namespace.go index b8a1122d0..4679bd45b 100644 --- a/godoc/vfs/namespace.go +++ b/godoc/vfs/namespace.go @@ -108,7 +108,7 @@ type mountedFS struct { new string } -// hasPathPrefix returns true if x == y or x == y + "/" + more +// hasPathPrefix reports whether x == y or x == y + "/" + more. func hasPathPrefix(x, y string) bool { return x == y || strings.HasPrefix(x, y) && (strings.HasSuffix(y, "/") || strings.HasPrefix(x[len(y):], "/")) }