Clarify documentation for 'list.group'

voneiden · lpil · commit ec9cc3f3a88a · 2024-11-15T15:46:50.000Z
diff --git a/src/gleam/list.gleam b/src/gleam/list.gleam
@@ -254,8 +254,7 @@ pub fn rest(list: List(a)) -> Result(List(a), Nil) {
   }
 }
 
-/// Takes a list and groups the values by a key
-/// which is built from a key function.
+/// Groups the elements from the given list by the given key function.
 ///
 /// Does not preserve the initial value order.
 ///

Original file line number	Diff line number	Diff line change
`@@ -254,8 +254,7 @@ pub fn rest(list: List(a)) -> Result(List(a), Nil) {`
`254`	`254`	`}`
`255`	`255`	`}`
`256`	`256`
`257`		`-/// Takes a list and groups the values by a key`
`258`		`-/// which is built from a key function.`
	`257`	`+/// Groups the elements from the given list by the given key function.`
`259`	`258`	`///`
`260`	`259`	`/// Does not preserve the initial value order.`
`261`	`260`	`///`