chore: add missing flatten combinator description from documentation

purpleclay · Oct 14, 2024 · 6b1061e · 6b1061e
1 parent 12c9d0e
commit 6b1061e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
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 change
@@ Expand Up / @@ -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]
     ----
@@ Expand Down @@