From 4943602689657203ba763d4f7107f2fd8048c864 Mon Sep 17 00:00:00 2001
From: Peter <peterhsaxton@gmail.com>
Date: Fri, 14 Aug 2020 08:52:33 +0100
Subject: add docs

---
 src/gleam/list.gleam | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'src')

diff --git a/src/gleam/list.gleam b/src/gleam/list.gleam
index c82db2e..456310e 100644
--- a/src/gleam/list.gleam
+++ b/src/gleam/list.gleam
@@ -630,6 +630,16 @@ fn do_unzip(input, xs, ys) {
   }
 }
 
+/// Takes a single list of 2 item tuples and returns two lists.
+///
+/// ## Examples
+///
+///    > unzip([tuple(1, 2), tuple(3, 4)])
+///    tuple([1, 3], [2, 4])
+///
+///    > unzip([])
+///    tuple([], [])
+///
 pub fn unzip(input: List(tuple(a, b))) -> tuple(List(a), List(b)) {
   do_unzip(input, [], [])
 }
-- 
cgit v1.2.3