aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLouis Pilfold <louis@lpil.uk>2023-07-13 14:38:46 +0100
committerLouis Pilfold <louis@lpil.uk>2023-07-13 14:38:46 +0100
commit4942ac97ff67c97c0673b8131244e78ae35a341e (patch)
treea5b48e451a0558d46debc3690ed19e6f9f5d9f46
parent55e7b16fefdcc477719dda3e606828e154c35bdf (diff)
downloadgleam_stdlib-4942ac97ff67c97c0673b8131244e78ae35a341e.tar.gz
gleam_stdlib-4942ac97ff67c97c0673b8131244e78ae35a341e.zip
Add deprecated version
-rw-r--r--CHANGELOG.md3
-rw-r--r--src/gleam/list.gleam6
2 files changed, 8 insertions, 1 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 18f9c04..6213b65 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,7 +3,8 @@
## Unreleased
- The `list` module gains the `list.map2` function.
-- `flatten` has been renamed to `concat` in the `list` module.
+- `flatten` has been renamed to `concat` in the `list` module. The old name is
+ still available as an alias and is deprecated.
## v0.29.2 - 2023-06-21
diff --git a/src/gleam/list.gleam b/src/gleam/list.gleam
index ed1d718..75a66ef 100644
--- a/src/gleam/list.gleam
+++ b/src/gleam/list.gleam
@@ -683,6 +683,12 @@ pub fn concat(lists: List(List(a))) -> List(a) {
do_concat(lists, [])
}
+// TODO: Add deprecation attribute and then remove later.
+/// This function is deprecated, see `concat` instead.
+pub fn flatten(lists: List(List(a))) -> List(a) {
+ do_concat(lists, [])
+}
+
/// Maps the list with the given function into a list of lists, and then flattens it.
///
/// ## Examples