Remove most function-inline comments

Docstrings for functions are a good thing. But the inside of a function
should be written in a way that is self-explaining. Thus inline comments
are just extra stuff to maintain and read.

1 files changed, 0 insertions, 28 deletions

diff --git a/handler.go b/handler.go
index 0c51bf6..0166d95 100644
--- a/handler.go
+++ b/handler.go
@@ -17,7 +17,6 @@ const (
 
 func indexGet(w http.ResponseWriter, r *http.Request) {
 
-	// get data from database
 	cmd := "SELECT id,title FROM recipes ORDER BY title;"
 	rows, err := db.Query(cmd)
 	if err != nil {
@@ -26,14 +25,12 @@ func indexGet(w http.ResponseWriter, r *http.Request) {
 	}
 	defer rows.Close()
 
-	// prepare data store
 	type Element struct {
 		Id    string
 		Title string
 	}
 	elements := make([]Element, 0)
 
-	// scan database rows to data store
 	for rows.Next() {
 		var element Element
 		err := rows.Scan(&element.Id, &element.Title)
@@ -45,14 +42,12 @@ func indexGet(w http.ResponseWriter, r *http.Request) {
 		}
 	}
 
-	// render and return template
 	path := filepath.Join(config.Http.Templates, "index.html")
 	ServeTemplate(w, "index", path, elements)
 }
 
 func recipeGet(w http.ResponseWriter, r *http.Request) {
 
-	// get id from URL parameters
 	ids := r.URL.Query()["id"]
 	if len(ids) != 1 {
 		msg := fmt.Sprintf("Exactly 1 'id' URL parameter expected but %d provided.", len(ids))
@@ -61,14 +56,12 @@ func recipeGet(w http.ResponseWriter, r *http.Request) {
 	}
 	idStr := ids[0]
 
-	// validate id
 	idRegex := regexp.MustCompile(VALID_ID_REGEX)
 	if !(idRegex.MatchString(idStr)) {
 		http.Error(w, "Bad 'id' URL parameter.", 400)
 		return
 	}
 
-	// get data from database
 	cmd := fmt.Sprintf("SELECT title,upstream_url,description_markdown FROM recipes WHERE (id='%s');", idStr)
 	rows, err := db.Query(cmd)
 	if err != nil {
@@ -77,7 +70,6 @@ func recipeGet(w http.ResponseWriter, r *http.Request) {
 	}
 	defer rows.Close()
 
-	// prepare data store
 	type Element struct {
 		Id                          string
 		Title                       string
@@ -87,7 +79,6 @@ func recipeGet(w http.ResponseWriter, r *http.Request) {
 	}
 	elements := make([]Element, 0)
 
-	// scan database rows to data store
 	for rows.Next() {
 		var element Element
 		element.Id = idStr
@@ -100,7 +91,6 @@ func recipeGet(w http.ResponseWriter, r *http.Request) {
 		}
 	}
 
-	// check result
 	if len(elements) != 1 {
 		http.Error(w, "Expected exactly 1 recipe from database.", 500)
 		return
@@ -111,14 +101,12 @@ func recipeGet(w http.ResponseWriter, r *http.Request) {
 	goldmark.Convert([]byte(elements[0].DescriptionMarkdown), &buf)
 	elements[0].RenderedDescriptionMarkdown = buf.String()
 
-	// render and return template
 	path := filepath.Join(config.Http.Templates, "recipe.html")
 	ServeTemplate(w, "recipe", path, elements[0])
 }
 
 func recipePost(w http.ResponseWriter, r *http.Request) {
 
-	// get id from URL parameters
 	ids := r.URL.Query()["id"]
 	if len(ids) != 1 {
 		msg := fmt.Sprintf("Exactly 1 'id' URL parameter expected but %d provided.", len(ids))
@@ -127,14 +115,12 @@ func recipePost(w http.ResponseWriter, r *http.Request) {
 	}
 	idStr := ids[0]
 
-	// validate id
 	idRegex := regexp.MustCompile(VALID_ID_REGEX)
 	if !(idRegex.MatchString(idStr)) {
 		http.Error(w, "Bad 'id' URL parameter.", 400)
 		return
 	}
 
-	// read request body
 	buffer, _ := ioutil.ReadAll(r.Body) // FIXME error handling
 	body := string(buffer)
 	updateRecipe(body, idStr)
@@ -142,7 +128,6 @@ func recipePost(w http.ResponseWriter, r *http.Request) {
 
 func recipeEditGet(w http.ResponseWriter, r *http.Request) {
 
-	// get id from URL parameters
 	ids := r.URL.Query()["id"]
 	if len(ids) != 1 {
 		http.Error(w, "Exactly 1 'id' URL parameter expected.", 400)
@@ -150,14 +135,12 @@ func recipeEditGet(w http.ResponseWriter, r *http.Request) {
 	}
 	idStr := ids[0]
 
-	// validate id
 	idRegex := regexp.MustCompile(VALID_ID_REGEX)
 	if !(idRegex.MatchString(idStr)) {
 		http.Error(w, "Bad 'id' URL parameter.", 400)
 		return
 	}
 
-	// get data from database
 	cmd := fmt.Sprintf("SELECT title,upstream_url,description_markdown FROM recipes WHERE (id='%s');", idStr)
 	rows, err := db.Query(cmd)
 	if err != nil {
@@ -166,7 +149,6 @@ func recipeEditGet(w http.ResponseWriter, r *http.Request) {
 	}
 	defer rows.Close()
 
-	// prepare data store
 	type Element struct {
 		Id                          string
 		Title                       string
@@ -176,7 +158,6 @@ func recipeEditGet(w http.ResponseWriter, r *http.Request) {
 	}
 	elements := make([]Element, 0)
 
-	// scan database rows to data store
 	for rows.Next() {
 		var element Element
 		element.Id = idStr
@@ -189,20 +170,17 @@ func recipeEditGet(w http.ResponseWriter, r *http.Request) {
 		}
 	}
 
-	// check result
 	if len(elements) != 1 {
 		http.Error(w, "Did not get exactly one recipe from database.", 500)
 		return
 	}
 
-	// render and return template
 	path := filepath.Join(config.Http.Templates, "recipe_edit.html")
 	ServeTemplate(w, "recipe", path, elements[0])
 }
 
 func recipeEditPost(w http.ResponseWriter, r *http.Request) {
 
-	// get id from URL parameters
 	ids := r.URL.Query()["id"]
 	if len(ids) != 1 {
 		http.Error(w, "Exactly 1 'id' URL parameter expected.", 400)
@@ -210,14 +188,12 @@ func recipeEditPost(w http.ResponseWriter, r *http.Request) {
 	}
 	idStr := ids[0]
 
-	// validate id
 	idRegex := regexp.MustCompile(VALID_ID_REGEX)
 	if !(idRegex.MatchString(idStr)) {
 		http.Error(w, "Bad 'id' URL parameter.", 400)
 		return
 	}
 
-	// read request body
 	buffer, _ := ioutil.ReadAll(r.Body) // FIXME error handling
 	body := string(buffer)
 	updateRecipe(body, idStr)
@@ -225,7 +201,6 @@ func recipeEditPost(w http.ResponseWriter, r *http.Request) {
 
 func updateRecipe(body string, idStr string) {
 
-	// execute SQL UPDATE
 	_, _ = db.Exec(`
 		UPDATE
 			recipes
@@ -242,7 +217,6 @@ func updateRecipe(body string, idStr string) {
 
 func recipeImageGet(w http.ResponseWriter, r *http.Request) {
 
-	// get ID
 	ids := r.URL.Query()["id"]
 	if len(ids) != 1 {
 		http.Error(w, "Expected exactly one 'id' URL parameter.", 400)
@@ -250,14 +224,12 @@ func recipeImageGet(w http.ResponseWriter, r *http.Request) {
 	}
 	idStr := ids[0]
 
-	// validate ID
 	idRegex := regexp.MustCompile(VALID_ID_REGEX)
 	if !idRegex.MatchString(idStr) {
 		http.Error(w, "Bad 'id' URL parameter.", 400)
 		return
 	}
 
-	// serve image
 	path := fmt.Sprintf("recipes/image/%s.jpg", idStr)
 	ServeStorage(w, r, path)
 }