chore: add missing flatten combinator description from documentation

purpleclay · purpleclay · commit 6b1061ea5b22 · 2024-10-14T05:13:52.000+01:00
diff --git a/docs/combinators.adoc b/docs/combinators.adoc
@@ -577,6 +577,8 @@ ext: ""
 ....
 
 |https://pkg.go.dev/github.com/purpleclay/chomp#Flatten[Flatten]
+
+Flattens the output from a combinator by joining all extracted values into a string
 |
 [source,go]
 ----
diff --git a/modifier.go b/modifier.go
@@ -105,7 +105,7 @@ func Peek[T Result](c Combinator[T]) Combinator[T] {
 	}
 }
 
-// Flatten the output of a [Combinator] by joining all extracted values
+// Flatten the output from a [Combinator] by joining all extracted values
 // into a string.
 //
 //	chomp.Flatten(

Original file line number	Diff line number	Diff line change
`@@ -577,6 +577,8 @@ ext: ""`
`577`	`577`	`....`
`578`	`578`
`579`	`579`	`\|https://pkg.go.dev/github.com/purpleclay/chomp#Flatten[Flatten]`
	`580`	`+`
	`581`	`+Flattens the output from a combinator by joining all extracted values into a string`
`580`	`582`	`\|`
`581`	`583`	`[source,go]`
`582`	`584`	`----`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ func Peek[T Result](c Combinator[T]) Combinator[T] {`
`105`	`105`	`}`
`106`	`106`	`}`
`107`	`107`
`108`		`-// Flatten the output of a [Combinator] by joining all extracted values`
	`108`	`+// Flatten the output from a [Combinator] by joining all extracted values`
`109`	`109`	`// into a string.`
`110`	`110`	`//`
`111`	`111`	`// chomp.Flatten(`