From a4f47e4bf0a8bb02031294e609278ae8c01d360a Mon Sep 17 00:00:00 2001 From: Dmitri Shuralyov Date: Tue, 7 May 2019 00:57:30 -0400 Subject: [PATCH] internal/code: adjust ModuleHandler documentation Re-arrange it in a better way, improve formatting. --- internal/code/module.go | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/internal/code/module.go b/internal/code/module.go index 1594ea6..268f5f9 100644 --- a/internal/code/module.go +++ b/internal/code/module.go @@ -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 }