Skip to content

Commit 8a95802

Browse files
authored
go/vcs: add package comment
According to https://golang.org/doc/effective_go.html#commentary, "Every package should have a package comment." Updates golang/go#11490.
1 parent 70252de commit 8a95802

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

go/vcs/vcs.go

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22
// Use of this source code is governed by a BSD-style
33
// license that can be found in the LICENSE file.
44

5+
// Package vcs exposes functions for resolving import paths
6+
// and using version control systems (like Mercurial, Git, or Subversion),
7+
// which can be used to implement behavior consistent with
8+
// the standard "go get" command.
9+
//
10+
// This package is a copy of internal code in package cmd/go/internal/get,
11+
// modified to make the identifiers exported. It's provided here
12+
// for developers who want to write tools with similar semantics.
13+
// It needs to be manually kept in sync with upstream when changes are
14+
// done to cmd/go/internal/get, see https://golang.org/issues/11490.
15+
//
516
package vcs // import "golang.org/x/tools/go/vcs"
617

718
import (

0 commit comments

Comments
 (0)