Skip to content

Commit

Permalink
internal/code: adjust ModuleHandler documentation
Browse files Browse the repository at this point in the history
Re-arrange it in a better way, improve formatting.
  • Loading branch information
dmitshur committed May 7, 2019
1 parent 1ff7a4b commit a4f47e4
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions internal/code/module.go
Expand Up @@ -28,20 +28,24 @@ import (
)

// ModuleHandler is a Go module server that implements the
// module proxy protocol. It serves each repository root
// available in Code as a Go module.
// module proxy protocol.
//
// At this time, it has various limitations compared to the
// general go mod download functionality that extracts module
// versions from a VCS repository:
//
// • Versions served include only pseudo-versions from
// commits on master branch. Tags and other branches
// are not supported at this time.
// • Multi-module repositories are not supported at this time.
// • Versions served include only pseudo-versions from
// commits on master branch. Tags and other branches
// are not supported at this time.
//
// • Multi-module repositories are not supported at this time.
//
// • Major versions other than v0 are not supported at this time.
//
// This may change over time as my needs evolve.
type ModuleHandler struct {
// Code is the underlying source of Go code.
// Each repository root available in it is served as a Go module.
Code *Service
}

Expand Down

0 comments on commit a4f47e4

Please sign in to comment.