Document line comment

README.md

@@ -55,9 +55,30 @@ func TestSomething(t *testing.T) {
 }
 ```
 
+### Self Documenting Tests
+
 > [!TIP]
 > Line comments on the line you call most `test` functions on will be shown in failure messages as additional context
 
+That means you can have additional context in the failure message, as well as helpful comments explaining the assertion to readers of your code
+
+```go
+func TestSomething(t *testing.T) {
+    test.Equal(t, "apples", "oranges") // Fruits are not equal
+}
+```
+
+Will get you a failure message like:
+
+```shell
+--- FAIL: TestSomething (0.00s)
+    something_test.go:1: 
+        Not Equal  // Fruits are not equal
+        ---------
+        Got:    apples
+        Wanted: oranges
+```
+
 ### Non Comparable Types
 
 `test` uses Go 1.18+ generics under the hood for most of the comparison, which is great, but what if your types don't satisfy `comparable`. We also provide

test_test.go

@@ -578,3 +578,7 @@ func TestCapture(t *testing.T) {
 		test.Equal(t, stderr, "")
 	})
 }
+
+func TestSomething(t *testing.T) {
+	test.Equal(t, "apples", "oranges") // Fruits are not equal
+}