doc(pkg/cleaner/cleaner.go): add godoc for the run function

Aaron Schlesinger · Aaron Schlesinger · commit ccca9b5e303a · 2016-02-18T16:10:20.000-08:00
diff --git a/pkg/cleaner/cleaner.go b/pkg/cleaner/cleaner.go
@@ -69,6 +69,8 @@ func getDisjunction(namespaceList []api.Namespace, dirs []string) []string {
 	return ret
 }
 
+// Run starts the deleted app cleaner. Every pollInterval, it compares the result of nsLister.List with the directories in the top level of gitHome on the local file system. On any error, it uses log.Debug to output a human readable description of what happened.
+// TODO: locking mechanism on repositories. Nobody should be able to push to a repo while one is being deleted
 func Run(gitHome string, nsLister k8s.NamespaceLister, pollInterval time.Duration) error {
 	for {
 		nsList, err := nsLister.List(labels.Everything(), fields.Everything())

Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,8 @@ func getDisjunction(namespaceList []api.Namespace, dirs []string) []string {`
`69`	`69`	`return ret`
`70`	`70`	`}`
`71`	`71`
	`72`	`+// Run starts the deleted app cleaner. Every pollInterval, it compares the result of nsLister.List with the directories in the top level of gitHome on the local file system. On any error, it uses log.Debug to output a human readable description of what happened.`
	`73`	`+// TODO: locking mechanism on repositories. Nobody should be able to push to a repo while one is being deleted`
`72`	`74`	`func Run(gitHome string, nsLister k8s.NamespaceLister, pollInterval time.Duration) error {`
`73`	`75`	`for {`
`74`	`76`	`nsList, err := nsLister.List(labels.Everything(), fields.Everything())`