Improve docs of HTTP target format comments

tsenart · Jan 4, 2019 · 65db074 · 65db074
1 parent 7b55bde
commit 65db074
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -237,7 +237,8 @@ X-Account-ID: 99
 ```
 
 ###### Add comments to the targets
-Lines starting with # are ignored.
+
+Lines starting with `#` are ignored.
 
 ```
 # get a dragon ball

diff --git a/lib/targets_test.go b/lib/targets_test.go
@@ -311,7 +311,7 @@ func TestNewHTTPTargeter(t *testing.T) {
 
 		SUBSCRIBE http://foobar.org/sub
 
-		# GET TEST
+		# This is a comment. Lines starting with hash pound are ignored.
 		GET http://:6060/
 		X-Header: 1
 		X-Header: 2`,
@@ -365,7 +365,7 @@ func TestNewHTTPTargeter(t *testing.T) {
 			Body:   []byte{},
 			Header: http.Header{"Content-Type": []string{"text/plain"}},
 		},
-		{
+		{ // Preceeding comment is ignored and target is parsed correctly.
 			Method: "GET",
 			URL:    "http://:6060/",
 			Body:   []byte{},