From 440b97d47f82f0acc9f44b9b10412008e3506256 Mon Sep 17 00:00:00 2001 From: Scott Richmond Date: Sun, 20 Oct 2024 14:50:22 -0400 Subject: [PATCH] update prelude documentation --- prelude.md | 189 +++++++++++++++++++++++++++++------------------------ 1 file changed, 102 insertions(+), 87 deletions(-) diff --git a/prelude.md b/prelude.md index c0c3c1d..b0473c6 100644 --- a/prelude.md +++ b/prelude.md @@ -65,7 +65,7 @@ You can see what this looks like in the last clause of `add`: `((x1, y1), (x2, y [any?](#any)    [append](#append)    [coll?](#coll)    [concat](#concat)    [contains?](#contains)    [count](#count)    [empty?](#empty)    [omit](#omit)    [random](#random)    [set](#set)    [set?](#set) ### Strings -[any?](#any)    [concat](#concat)    [count](#count)    [downcase](#downcase)    [empty?](#empty)    [join](#join)    [sentence](#sentence)    [show](#show)    [slice](#slice)    [split](#split)    [string](#string)    [string?](#string)    [strip](#strip)    [trim](#trim)    [upcase](#upcase)    [words](#words) +[any?](#any)    [chars](#chars)    [chars/safe](#chars/safe)    [concat](#concat)    [count](#count)    [downcase](#downcase)    [empty?](#empty)    [join](#join)    [sentence](#sentence)    [show](#show)    [slice](#slice)    [split](#split)    [string](#string)    [string?](#string)    [strip](#strip)    [trim](#trim)    [upcase](#upcase)    [words](#words) ### Tuples [any?](#any)    [at](#at)    [coll?](#coll)    [count](#count)    [empty?](#empty)    [first](#first)    [last](#last)    [ordered?](#ordered)    [rest](#rest)    [second](#second)    [tuple?](#tuple) @@ -77,7 +77,7 @@ You can see what this looks like in the last clause of `add`: `((x1, y1), (x2, y [assoc?](#assoc)    [bool?](#bool)    [box?](#box)    [coll?](#coll)    [dict?](#dict)    [eq?](#eq)    [fn?](#fn)    [keyword?](#keyword)    [list?](#list)    [neq?](#neq)    [nil?](#nil)    [number?](#number)    [ordered?](#ordered)    [set?](#set)    [show](#show)    [some](#some)    [some?](#some)    [string?](#string)    [tuple?](#tuple)    [type](#type) ## All functions, alphabetically -[abs](#abs)    [add](#add)    [and](#and)    [angle](#angle)    [any?](#any)    [append](#append)    [assert!](#assert)    [assoc](#assoc)    [assoc?](#assoc)    [at](#at)    [atan/2](#atan/2)    [back!](#back)    [background!](#background)    [between?](#between)    [bg!](#bg)    [bgcolor](#bgcolor)    [bk!](#bk)    [bool](#bool)    [bool?](#bool)    [box?](#box)    [butlast](#butlast)    [ceil](#ceil)    [clear!](#clear)    [coll?](#coll)    [colors](#colors)    [concat](#concat)    [contains?](#contains)    [cos](#cos)    [count](#count)    [dec](#dec)    [deg/rad](#deg/rad)    [deg/turn](#deg/turn)    [dict](#dict)    [dict?](#dict)    [diff](#diff)    [dissoc](#dissoc)    [dist](#dist)    [div](#div)    [div/0](#div/0)    [div/safe](#div/safe)    [doc!](#doc)    [downcase](#downcase)    [each!](#each)    [empty?](#empty)    [eq?](#eq)    [err](#err)    [err?](#err)    [even?](#even)    [false?](#false)    [fd!](#fd)    [filter](#filter)    [first](#first)    [floor](#floor)    [fn?](#fn)    [fold](#fold)    [forward!](#forward)    [get](#get)    [goto!](#goto)    [gt?](#gt)    [gte?](#gte)    [heading](#heading)    [heading/vector](#heading/vector)    [home!](#home)    [inc](#inc)    [inv](#inv)    [inv/0](#inv/0)    [inv/safe](#inv/safe)    [join](#join)    [keep](#keep)    [keys](#keys)    [keyword?](#keyword)    [last](#last)    [left!](#left)    [list](#list)    [list?](#list)    [load\_turtle_state!](#load\_turtle_state)    [lt!](#lt)    [lt?](#lt)    [lte?](#lte)    [map](#map)    [max](#max)    [min](#min)    [mod](#mod)    [mod/0](#mod/0)    [mod/safe](#mod/safe)    [mult](#mult)    [neg](#neg)    [neg?](#neg)    [neq?](#neq)    [nil?](#nil)    [not](#not)    [odd?](#odd)    [ok](#ok)    [ok?](#ok)    [omit](#omit)    [or](#or)    [ordered?](#ordered)    [p5\_calls](#p5\_calls)    [pc!](#pc)    [pd!](#pd)    [pencolor](#pencolor)    [pencolor!](#pencolor)    [pendown!](#pendown)    [pendown?](#pendown)    [penup!](#penup)    [penwidth](#penwidth)    [penwidth!](#penwidth)    [pi](#pi)    [pos?](#pos)    [position](#position)    [print!](#print)    [pu!](#pu)    [pw!](#pw)    [rad/deg](#rad/deg)    [rad/turn](#rad/turn)    [random](#random)    [random\_int](#random\_int)    [range](#range)    [render\_turtle!](#render\_turtle)    [report!](#report)    [reset\_turtle!](#reset\_turtle)    [rest](#rest)    [right!](#right)    [round](#round)    [rt!](#rt)    [second](#second)    [sentence](#sentence)    [set](#set)    [set?](#set)    [show](#show)    [sin](#sin)    [slice](#slice)    [some](#some)    [some?](#some)    [split](#split)    [sqrt](#sqrt)    [sqrt/safe](#sqrt/safe)    [square](#square)    [state](#state)    [store!](#store)    [string](#string)    [string?](#string)    [strip](#strip)    [sub](#sub)    [sum\_of_squares](#sum\_of_squares)    [tan](#tan)    [tau](#tau)    [trim](#trim)    [tuple?](#tuple)    [turn/deg](#turn/deg)    [turn/rad](#turn/rad)    [turtle\_commands](#turtle\_commands)    [turtle\_state](#turtle\_state)    [turtle\_states](#turtle\_states)    [type](#type)    [unbox](#unbox)    [unwrap!](#unwrap)    [unwrap\_or](#unwrap\_or)    [upcase](#upcase)    [update](#update)    [update!](#update)    [values](#values)    [words](#words)    [ws?](#ws)    [zero?](#zero) +[abs](#abs)    [add](#add)    [and](#and)    [angle](#angle)    [any?](#any)    [append](#append)    [assert!](#assert)    [assoc](#assoc)    [assoc?](#assoc)    [at](#at)    [atan/2](#atan/2)    [back!](#back)    [background!](#background)    [between?](#between)    [bg!](#bg)    [bk!](#bk)    [bool](#bool)    [bool?](#bool)    [box?](#box)    [butlast](#butlast)    [ceil](#ceil)    [chars](#chars)    [clear!](#clear)    [coll?](#coll)    [colors](#colors)    [concat](#concat)    [contains?](#contains)    [cos](#cos)    [count](#count)    [dec](#dec)    [deg/rad](#deg/rad)    [deg/turn](#deg/turn)    [dict](#dict)    [dict?](#dict)    [diff](#diff)    [dissoc](#dissoc)    [dist](#dist)    [div](#div)    [div/0](#div/0)    [div/safe](#div/safe)    [doc!](#doc)    [downcase](#downcase)    [each!](#each)    [empty?](#empty)    [eq?](#eq)    [err](#err)    [err?](#err)    [even?](#even)    [false?](#false)    [fd!](#fd)    [filter](#filter)    [first](#first)    [floor](#floor)    [fn?](#fn)    [fold](#fold)    [forward!](#forward)    [get](#get)    [goto!](#goto)    [gt?](#gt)    [gte?](#gte)    [heading](#heading)    [heading/vector](#heading/vector)    [hideturtle!](#hideturtle)    [home!](#home)    [inc](#inc)    [inv](#inv)    [inv/0](#inv/0)    [inv/safe](#inv/safe)    [join](#join)    [keep](#keep)    [keys](#keys)    [keyword?](#keyword)    [last](#last)    [left!](#left)    [list](#list)    [list?](#list)    [loadstate!](#loadstate)    [lt!](#lt)    [lt?](#lt)    [lte?](#lte)    [map](#map)    [max](#max)    [min](#min)    [mod](#mod)    [mod/0](#mod/0)    [mod/safe](#mod/safe)    [mult](#mult)    [neg](#neg)    [neg?](#neg)    [neq?](#neq)    [nil?](#nil)    [not](#not)    [odd?](#odd)    [ok](#ok)    [ok?](#ok)    [omit](#omit)    [or](#or)    [ordered?](#ordered)    [pc!](#pc)    [pd!](#pd)    [pencolor](#pencolor)    [pencolor!](#pencolor)    [pendown!](#pendown)    [pendown?](#pendown)    [penup!](#penup)    [penwidth](#penwidth)    [penwidth!](#penwidth)    [pi](#pi)    [pos?](#pos)    [position](#position)    [print!](#print)    [pu!](#pu)    [pw!](#pw)    [rad/deg](#rad/deg)    [rad/turn](#rad/turn)    [random](#random)    [random\_int](#random\_int)    [range](#range)    [report!](#report)    [rest](#rest)    [right!](#right)    [round](#round)    [rt!](#rt)    [second](#second)    [sentence](#sentence)    [set](#set)    [set?](#set)    [setheading!](#setheading)    [show](#show)    [showturtle!](#showturtle)    [sin](#sin)    [slice](#slice)    [some](#some)    [some?](#some)    [split](#split)    [sqrt](#sqrt)    [sqrt/safe](#sqrt/safe)    [square](#square)    [state](#state)    [store!](#store)    [string](#string)    [string?](#string)    [strip](#strip)    [sub](#sub)    [sum\_of_squares](#sum\_of_squares)    [tan](#tan)    [tau](#tau)    [trim](#trim)    [tuple?](#tuple)    [turn/deg](#turn/deg)    [turn/rad](#turn/rad)    [turtle\_commands](#turtle\_commands)    [turtle\_init](#turtle\_init)    [turtle\_state](#turtle\_state)    [type](#type)    [unbox](#unbox)    [unwrap!](#unwrap)    [unwrap\_or](#unwrap\_or)    [upcase](#upcase)    [update](#update)    [update!](#update)    [values](#values)    [words](#words)    [ws?](#ws)    [zero?](#zero) ## Function documentation ### abs @@ -95,7 +95,7 @@ Adds numbers or vectors. () (x as :number) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) ((x1, y1), (x2, y2)) ``` [Back to top.](#ludus-prelude-documentation) @@ -107,7 +107,7 @@ Returns true if all values passed in are truthy. Note that this does not short-c () (x) (x, y) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -158,9 +158,9 @@ Asserts a condition: returns the value if the value is truthy, panics if the val Takes a dict, key, and value, and returns a new dict with the key set to value. ``` () -(dict as :dict) -(dict as :dict, key as :keyword, value) -(dict as :dict, (key as :keyword, value)) +(d as :dict) +(d as :dict, k as :keyword, val) +(d as :dict, (k as :keyword, val)) ``` [Back to top.](#ludus-prelude-documentation) @@ -168,8 +168,8 @@ Takes a dict, key, and value, and returns a new dict with the key set to value. ### assoc? Returns true if a value is an associative collection: a dict or a pkg. ``` -(assoc as :dict) -(assoc as :pkg) +(d as :dict) +(p as :pkg) (_) ``` [Back to top.](#ludus-prelude-documentation) @@ -210,6 +210,7 @@ Moves the turtle backward by a number of steps. Alias: bk! ### background! Sets the background color behind the turtle and path. Alias: bg! ``` +(color as :keyword) (gray as :number) ((r as :number, g as :number, b as :number)) ((r as :number, g as :number, b as :number, a as :number)) @@ -228,16 +229,13 @@ Returns true if a number is in the range [lower, higher): greater than or equal ### bg! Sets the background color behind the turtle and path. Alias: bg! ``` +(color as :keyword) (gray as :number) ((r as :number, g as :number, b as :number)) ((r as :number, g as :number, b as :number, a as :number)) ``` [Back to top.](#ludus-prelude-documentation) ---- -### bgcolor -No documentation available. - --- ### bk! Moves the turtle backward by a number of steps. Alias: bk! @@ -291,6 +289,14 @@ Truncates a number towards positive infinity. With negative numbers, it returns ``` [Back to top.](#ludus-prelude-documentation) +--- +### chars +Takes a string and returns its characters as a list. Works only for strings with only ascii characters. Panics on any non-ascii characters. +``` +(str as :string) +``` +[Back to top.](#ludus-prelude-documentation) + --- ### clear! Clears the canvas and sends the turtle home. @@ -322,7 +328,7 @@ Combines two lists, strings, or sets. (x as :string, y as :string) (xs as :list, ys as :list) (xs as :set, ys as :set) -(xs, ys, ...) +(xs, ys, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -330,8 +336,8 @@ Combines two lists, strings, or sets. ### contains? Returns true if a set or list contains a value. ``` -(value, set as :set) -(value, list as :list) +(value, s as :set) +(value, l as :list) ``` [Back to top.](#ludus-prelude-documentation) @@ -386,9 +392,9 @@ Converts an angle in degrees to an angle in turns. ### dict Takes a list or tuple of (key, value) tuples and returns it as a dict. Returns dicts unharmed. ``` -(dict as :dict) -(list as :list) -(tup as :tuple) +(d as :dict) +(l as :list) +(t as :tuple) ``` [Back to top.](#ludus-prelude-documentation) @@ -396,7 +402,7 @@ Takes a list or tuple of (key, value) tuples and returns it as a dict. Returns d ### dict? Returns true if a value is a dict. ``` -(dict as :dict) +(d as :dict) (_) ``` [Back to top.](#ludus-prelude-documentation) @@ -413,8 +419,8 @@ Takes two dicts and returns a dict describing their differences. Does this shall ### dissoc Takes a dict and a key, and returns a new dict with the key and associated value omitted. ``` -(dict as :dict) -(dict as :dict, key as :keyword) +(d as :dict) +(d as :dict, k as :keyword) ``` [Back to top.](#ludus-prelude-documentation) @@ -434,7 +440,7 @@ Divides numbers. Panics on division by zero. (x as :number) (_, 0) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -445,7 +451,7 @@ Divides numbers. Returns 0 on division by zero. (x as :number) (_, 0) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -456,7 +462,7 @@ Divides a number. Returns a result tuple. (x as :number) (_, 0) (x, y) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -483,7 +489,7 @@ Takes a list and applies a function, presumably with side effects, to each eleme ``` (f! as :fn, []) (f! as :fn, [x]) -(f! as :fn, [x, ...]) +(f! as :fn, [x, ...xs]) ``` [Back to top.](#ludus-prelude-documentation) @@ -506,7 +512,7 @@ Returns true if all arguments have the same value. ``` (x) (x, y) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -590,7 +596,9 @@ Returns true if an argument is a function. ### fold Folds a list. ``` +(f as :fn, []) (f as :fn, xs as :list) +(f as :fn, [], root) (f as :fn, xs as :list, root) ``` [Back to top.](#ludus-prelude-documentation) @@ -607,9 +615,9 @@ Moves the turtle forward by a number of steps. Alias: fd! ### get Takes a key, dict, and optional default value; returns the value at key. If the value is not found, returns nil or the default value. ``` -(key as :keyword) -(key as :keyword, dict as :dict) -(key as :keyword, dict as :dict, default) +(k as :keyword) +(k as :keyword, d as :dict) +(k as :keyword, d as :dict, default) ``` [Back to top.](#ludus-prelude-documentation) @@ -628,7 +636,7 @@ Returns true if numbers are in decreasing order. ``` (x as :number) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -638,7 +646,7 @@ Returns true if numbers are in decreasing or flat order. ``` (x as :number) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -658,6 +666,14 @@ Takes a turtle heading, and returns a unit vector of that heading. ``` [Back to top.](#ludus-prelude-documentation) +--- +### hideturtle! +If the turtle is visible, hides it. If the turtle is already hidden, does nothing. +``` +() +``` +[Back to top.](#ludus-prelude-documentation) + --- ### home! Sends the turtle home: to the centre of the screen, pointing up. If the pen is down, the turtle will draw a path to home. @@ -705,8 +721,9 @@ Takes a list of strings, and joins them into a single string, interposing an opt ([]) ([str as :string]) (strs as :list) +([], separator as :string) ([str as :string], separator as :string) -([str, ...], separator as :string) +([str, ...strs], separator as :string) ``` [Back to top.](#ludus-prelude-documentation) @@ -722,7 +739,7 @@ Takes a list and returns a new list with any `nil` values omitted. ### keys Takes a dict and returns a list of keys in that dict. ``` -(dict as :dict) +(d as :dict) ``` [Back to top.](#ludus-prelude-documentation) @@ -769,8 +786,8 @@ Returns true if the value is a list. [Back to top.](#ludus-prelude-documentation) --- -### load_turtle_state! -Sets the turtle state to a previously saved state. Returns the state. +### loadstate! +Sets the turtle state to a previously saved state. ``` (state) ``` @@ -790,7 +807,7 @@ Returns true if numbers are in increasing order. ``` (x as :number) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -800,7 +817,7 @@ Returns true if numbers are in increasing or flat order. ``` (x as :number) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -819,7 +836,7 @@ Returns the number in its arguments that is closest to positive infinity. ``` (x as :number) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -829,34 +846,34 @@ Returns the number in its arguments that is closest to negative infinity. ``` (x as :number) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) --- ### mod -Returns the modulus of num and div. Truncates towards negative infinity. Panics if div is 0. +Returns the modulus of x and y. Truncates towards negative infinity. Panics if y is 0. ``` -(num as :number, 0) -(num as :number, div as :number) +(x as :number, 0) +(x as :number, y as :number) ``` [Back to top.](#ludus-prelude-documentation) --- ### mod/0 -Returns the modulus of num and div. Truncates towards negative infinity. Returns 0 if div is 0. +Returns the modulus of x and y. Truncates towards negative infinity. Returns 0 if y is 0. ``` -(num as :number, 0) -(num as :number, div as :number) +(x as :number, 0) +(x as :number, y as :number) ``` [Back to top.](#ludus-prelude-documentation) --- ### mod/safe -Returns the modulus of num and div in a result tuple, or an error if div is 0. Truncates towards negative infinity. +Returns the modulus of x and y in a result tuple, or an error if y is 0. Truncates towards negative infinity. ``` -(num as :number, 0) -(num as :number, div as :number) +(x as :number, 0) +(x as :number, y as :number) ``` [Back to top.](#ludus-prelude-documentation) @@ -867,7 +884,7 @@ Multiplies numbers or vectors. () (x as :number) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) (scalar as :number, (x, y)) ((x, y), scalar as :number) ``` @@ -896,7 +913,7 @@ Returns true if none of the arguments have the same value. ``` (x) (x, y) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -960,7 +977,7 @@ Returns true if any value passed in is truthy. Note that this does not short-cir () (x) (x, y) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -970,18 +987,16 @@ Returns true if a value is an indexed collection: list or tuple. ``` (coll as :list) (coll as :tuple) +(coll as :string) (_) ``` [Back to top.](#ludus-prelude-documentation) ---- -### p5_calls -No documentation available. - --- ### pc! Changes the turtle's pen color. Takes a single grayscale value, an rgb tuple, or an rgba tuple. Alias: pc! ``` +(color as :keyword) (gray as :number) ((r as :number, g as :number, b as :number)) ((r as :number, g as :number, b as :number, a as :number)) @@ -998,7 +1013,7 @@ Lowers the turtle's pen, causing it to draw. Alias: pd! --- ### pencolor -Returns the turtle's pen color as an (r, g, b, a) tuple. +Returns the turtle's pen color as an (r, g, b, a) tuple or keyword. ``` () ``` @@ -1008,6 +1023,7 @@ Returns the turtle's pen color as an (r, g, b, a) tuple. ### pencolor! Changes the turtle's pen color. Takes a single grayscale value, an rgb tuple, or an rgba tuple. Alias: pc! ``` +(color as :keyword) (gray as :number) ((r as :number, g as :number, b as :number)) ((r as :number, g as :number, b as :number, a as :number)) @@ -1079,7 +1095,7 @@ Returns the turtle's current position. ### print! Sends a text representation of Ludus values to the console. ``` -(...) +(...args) ``` [Back to top.](#ludus-prelude-documentation) @@ -1146,14 +1162,6 @@ Returns the set of integers between start (inclusive) and end (exclusive) as a l ``` [Back to top.](#ludus-prelude-documentation) ---- -### render_turtle! -No docstring available. -``` -() -``` -[Back to top.](#ludus-prelude-documentation) - --- ### report! Prints a value, then returns it. @@ -1163,20 +1171,15 @@ Prints a value, then returns it. ``` [Back to top.](#ludus-prelude-documentation) ---- -### reset_turtle! -Resets the turtle to its original state. -``` -() -``` -[Back to top.](#ludus-prelude-documentation) - --- ### rest Returns all but the first element of a list or tuple, as a list. ``` +([]) +(()) (xs as :list) (xs as :tuple) +(xs as :string) ``` [Back to top.](#ludus-prelude-documentation) @@ -1238,6 +1241,14 @@ Returns true if a value is a set. ``` [Back to top.](#ludus-prelude-documentation) +--- +### setheading! +Sets the turtle's heading. The angle is specified in turns, with 0 pointing up. Increasing values rotate the turtle counter-clockwise. +``` +(heading as :number) +``` +[Back to top.](#ludus-prelude-documentation) + --- ### show Returns a text representation of a Ludus value as a string. @@ -1246,6 +1257,14 @@ Returns a text representation of a Ludus value as a string. ``` [Back to top.](#ludus-prelude-documentation) +--- +### showturtle! +If the turtle is hidden, shows the turtle. If the turtle is already visible, does nothing. +``` +() +``` +[Back to top.](#ludus-prelude-documentation) + --- ### sin Returns the sine of an angle. Default angle measure is turns. An optional keyword argument specifies the units of the angle passed in. @@ -1336,7 +1355,7 @@ Converts a value to a string by using `show`. If it is a string, returns it unha ``` (x as :string) (x) -(x, ...) +(x, ...xs) ``` [Back to top.](#ludus-prelude-documentation) @@ -1370,7 +1389,7 @@ Subtracts numbers or vectors. () (x as :number) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) ((x1, y1), (x2, y2)) ``` [Back to top.](#ludus-prelude-documentation) @@ -1382,7 +1401,7 @@ Returns the sum of squares of numbers. () (x as :number) (x as :number, y as :number) -(x, y, ...) +(x, y, ...zs) ``` [Back to top.](#ludus-prelude-documentation) @@ -1441,15 +1460,11 @@ Converts an angle in turns to an angle in radians. No documentation available. --- -### turtle_state -Returns the turtle's current state. -``` -() -``` -[Back to top.](#ludus-prelude-documentation) +### turtle_init +No documentation available. --- -### turtle_states +### turtle_state No documentation available. --- @@ -1499,8 +1514,8 @@ Takes a string and returns it in all uppercase. Works only for ascii characters. ### update Takes a dict, key, and function, and returns a new dict with the key set to the result of applying the function to original value held at the key. ``` -(dict as :dict) -(dict as :dict, key as :keyword, updater as :fn) +(d as :dict) +(d as :dict, k as :keyword, updater as :fn) ``` [Back to top.](#ludus-prelude-documentation) @@ -1516,7 +1531,7 @@ Updates a box by applying a function to its value. Returns the new value. ### values Takes a dict and returns a list of values in that dict. ``` -(dict) +(d as :dict) ``` [Back to top.](#ludus-prelude-documentation)