From bca305d766c9363ff6067be5c43ee94c8ae2e0e4 Mon Sep 17 00:00:00 2001 From: "Ryan M. Moore" Date: Tue, 30 Apr 2024 14:13:49 -0400 Subject: Update examples for `dict.to_list` --- src/gleam/dict.gleam | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/gleam/dict.gleam b/src/gleam/dict.gleam index 4b0f333..8b459ec 100644 --- a/src/gleam/dict.gleam +++ b/src/gleam/dict.gleam @@ -42,14 +42,19 @@ pub fn size(dict: Dict(k, v)) -> Int /// /// ## Examples /// +/// Calling `to_list` on an empty `dict` returns an empty list. +/// /// ```gleam -/// new() -/// // -> from_list([]) +/// new() |> to_list +/// // -> [] /// ``` +/// +/// The ordering of elements in the resulting list is an implementation detail +/// that should not be relied upon. /// /// ```gleam -/// new() |> insert("key", 0) -/// // -> from_list([#("key", 0)]) +/// new() |> insert("b", 1) |> insert("a", 0) |> insert("c", 2) |> to_list +/// // -> [#("a", 0), #("b", 1), #("c", 2)] /// ``` /// @external(erlang, "maps", "to_list") -- cgit v1.2.3