Skip to content

Commit

Permalink
godoc, godoc/vfs: improve documentation of GetPageInfo, hasPathPrefix
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
dmitshur committed Sep 29, 2019
1 parent 7da961d commit e7abfed
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion godoc/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion godoc/vfs/namespace.go
Original file line number Diff line number Diff line change
Expand Up @@ -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):], "/"))
}
Expand Down

0 comments on commit e7abfed

Please sign in to comment.