add some code documentation

gvallee · gvallee · commit 313ece88685e · 2019-12-14T20:15:00.000-05:00
Signed-off-by: Geoffroy Vallee &lt;geoffroy.vallee@gmail.com&gt;
diff --git a/internal/pkg/distro/distro.go b/internal/pkg/distro/distro.go
@@ -14,6 +14,7 @@ import (
 	"github.com/sylabs/singularity-mpi/internal/pkg/sys"
 )
 
+// ID represents a Linux distribution
 type ID struct {
 	// Name is the name of the Linux distribution, e.g., ubuntu
 	Name string
@@ -25,6 +26,7 @@ type ID struct {
 	Codename string
 }
 
+// GetBaseImageLibraryURL returns the library URL to use as base image (when possible)
 func GetBaseImageLibraryURL(linuxDistro ID, sysCfg *sys.Config) string {
 	configFile := filepath.Join(sysCfg.EtcDir, "sympi_"+linuxDistro.Name+".conf")
 

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ import (`
`14`	`14`	`"github.com/sylabs/singularity-mpi/internal/pkg/sys"`
`15`	`15`	`)`
`16`	`16`
	`17`	`+// ID represents a Linux distribution`
`17`	`18`	`type ID struct {`
`18`	`19`	`// Name is the name of the Linux distribution, e.g., ubuntu`
`19`	`20`	`Name string`
`@@ -25,6 +26,7 @@ type ID struct {`
`25`	`26`	`Codename string`
`26`	`27`	`}`
`27`	`28`
	`29`	`+// GetBaseImageLibraryURL returns the library URL to use as base image (when possible)`
`28`	`30`	`func GetBaseImageLibraryURL(linuxDistro ID, sysCfg *sys.Config) string {`
`29`	`31`	`configFile := filepath.Join(sysCfg.EtcDir, "sympi_"+linuxDistro.Name+".conf")`
`30`	`32`