Merge pull request #40 from bitlux/dev

Fix some godoc comments

Author: bitlux

.github/workflows/golangci-lint.yml

@@ -1,9 +1,9 @@
 name: golangci-lint
 on:
   push:
-    branches: [ "master", "dev" ]
+    branches: [ "dev" ]
   pull_request:
-    branches: [ "master", "dev" ]
+    branches: [ "master" ]
 
 permissions:
   contents: read

ipieces/ipieces.go

@@ -1,46 +1,46 @@
 // Package ipieces allows users to create IP address-based Geocaching puzzles.
 //
-// To create a puzzle, you need to populate a [Puzzle] struct and call [Run] on it.
+// To create a puzzle, you need to populate a [Puzzle] struct and call [Puzzle.Run] on it.
 // For example:
 //
-//	 package main
+//	package main
 //
-//	 import (
-//	   "github.com/bitlux/caches/ipieces"
-//	   "github.com/bitlux/vpnapi"
-//	 )
+//	import (
+//	  "github.com/bitlux/caches/ipieces"
+//	  "github.com/bitlux/vpnapi"
+//	)
 //
-//	 func main() {
-//	   p := ipieces.Puzzle{
-//	 		 Final: []ipieces.Digit{
-//	       ipieces.Digit{Value: "3", Status: ipieces.VISIBLE}
-//	       ipieces.Digit{Value: "7", Status: ipieces.VISIBLE}
-//	       ipieces.Digit{Value: "2", Status: ipieces.VISIBLE}
-//	       ipieces.Digit{Value: "4", Status: ipieces.HIDDEN}
-//	       ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
-//	       ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
-//	       ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
-//	       ipieces.Digit{Value: "1", Status: ipieces.VISIBLE}
-//	       ipieces.Digit{Value: "2", Status: ipieces.VISIBLE}
-//	       ipieces.Digit{Value: "2", Status: ipieces.VISIBLE}
-//	       ipieces.Digit{Value: "0", Status: ipieces.VISIBLE}
-//	       ipieces.Digit{Value: "4", Status: ipieces.HIDDEN}
-//	       ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
-//	       ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
-//	       ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
-//		   },
-//	     IndexFunc: func(b [sha256.Size]byte) int {
-//	       return int(b[sha256.Size-1]) % 8
-//	     },
-//	     // Setting Client is optional.
-//		   Client:   vpnapi.New("YOUR-API-KEY-HERE"),
-//		   Backdoor: "topsecret",
-//	     GCCode:   "GCB2PKC",
-//	   }
-//	   p.Run()
-//	 }
+//	func main() {
+//	  p := ipieces.Puzzle{
+//	 	  Final: []ipieces.Digit{
+//	      ipieces.Digit{Value: "3", Status: ipieces.VISIBLE}
+//	      ipieces.Digit{Value: "7", Status: ipieces.VISIBLE}
+//	      ipieces.Digit{Value: "2", Status: ipieces.VISIBLE}
+//	      ipieces.Digit{Value: "4", Status: ipieces.HIDDEN}
+//	      ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
+//	      ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
+//	      ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
+//	      ipieces.Digit{Value: "1", Status: ipieces.VISIBLE}
+//	      ipieces.Digit{Value: "2", Status: ipieces.VISIBLE}
+//	      ipieces.Digit{Value: "2", Status: ipieces.VISIBLE}
+//	      ipieces.Digit{Value: "0", Status: ipieces.VISIBLE}
+//	      ipieces.Digit{Value: "4", Status: ipieces.HIDDEN}
+//	      ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
+//	      ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
+//	      ipieces.Digit{Value: "0", Status: ipieces.HIDDEN}
+//	    },
+//	    IndexFunc: func(b [sha256.Size]byte) int {
+//	      return int(b[sha256.Size-1]) % 8
+//	    },
+//	    // Setting Client is optional.
+//	    Client:   vpnapi.New("YOUR-API-KEY-HERE"),
+//	    Backdoor: "topsecret",
+//	    GCCode:   "GCB2PKC",
+//	  }
+//	  p.Run()
+//	}
 //
-// [Run] creates two handlers:
+// [Puzzle.Run] creates two handlers:
 //   - a text endpoint at `/text` which responds with a short plaintext page with the client's IP,
 //     the computed index into the final coordinates, and the revealed coordinate, and
 //   - a default endpoint, which serves any path other than `/text`, and responds with an HTML page.