Merge pull request #4 from CodeLingoBot/rewrite

Manuel Morejón · web-flow · commit f0c367378194 · 2019-03-15T20:41:52.000+01:00
Fix function comments based on best practices from Effective Go
diff --git a/bookings/common/utils.go b/bookings/common/utils.go
@@ -59,7 +59,7 @@ func initConfig() {
 // Session holds the mongodb session for database access
 var session *mgo.Session
 
-// Get database session
+// GetSession gets database session
 func GetSession() *mgo.Session {
 	if session == nil {
 		var err error
diff --git a/bookings/controllers/context.go b/bookings/controllers/context.go
@@ -16,7 +16,7 @@ func (c *Context) Close() {
 	c.MongoSession.Close()
 }
 
-// Returns mgo.collection for the given name
+// DbCollection returns mgo.collection for the given name
 func (c *Context) DbCollection(name string) *mgo.Collection {
 	return c.MongoSession.DB(common.AppConfig.Database).C(name)
 }
diff --git a/movies/common/utils.go b/movies/common/utils.go
@@ -59,7 +59,7 @@ func initConfig() {
 // Session holds the mongodb session for database access
 var session *mgo.Session
 
-// Get database session
+// GetSession gets database session
 func GetSession() *mgo.Session {
 	if session == nil {
 		var err error
diff --git a/movies/controllers/context.go b/movies/controllers/context.go
@@ -16,7 +16,7 @@ func (c *Context) Close() {
 	c.MongoSession.Close()
 }
 
-// Returns mgo.collection for the given name
+// DbCollection returns mgo.collection for the given name
 func (c *Context) DbCollection(name string) *mgo.Collection {
 	return c.MongoSession.DB(common.AppConfig.Database).C(name)
 }
diff --git a/showtimes/common/utils.go b/showtimes/common/utils.go
@@ -59,7 +59,7 @@ func initConfig() {
 // Session holds the mongodb session for database access
 var session *mgo.Session
 
-// Get database session
+// GetSession gets database session
 func GetSession() *mgo.Session {
 	if session == nil {
 		var err error
diff --git a/showtimes/controllers/context.go b/showtimes/controllers/context.go
@@ -16,7 +16,7 @@ func (c *Context) Close() {
 	c.MongoSession.Close()
 }
 
-// Returns mgo.collection for the given name
+// DbCollection returns mgo.collection for the given name
 func (c *Context) DbCollection(name string) *mgo.Collection {
 	return c.MongoSession.DB(common.AppConfig.Database).C(name)
 }
diff --git a/users/common/utils.go b/users/common/utils.go
@@ -59,7 +59,7 @@ func initConfig() {
 // Session holds the mongodb session for database access
 var session *mgo.Session
 
-// Get database session
+// GetSession gets database session
 func GetSession() *mgo.Session {
 	if session == nil {
 		var err error
diff --git a/users/controllers/context.go b/users/controllers/context.go
@@ -16,7 +16,7 @@ func (c *Context) Close() {
 	c.MongoSession.Close()
 }
 
-// Returns mgo.collection for the given name
+// DbCollection returns mgo.collection for the given name
 func (c *Context) DbCollection(name string) *mgo.Collection {
 	return c.MongoSession.DB(common.AppConfig.Database).C(name)
 }

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ func (c *Context) Close() {`
`16`	`16`	`c.MongoSession.Close()`
`17`	`17`	`}`
`18`	`18`
`19`		`-// Returns mgo.collection for the given name`
	`19`	`+// DbCollection returns mgo.collection for the given name`
`20`	`20`	`func (c Context) DbCollection(name string) mgo.Collection {`
`21`	`21`	`return c.MongoSession.DB(common.AppConfig.Database).C(name)`
`22`	`22`	`}`