From 671e82677f3e2e5f7e41ff783c3cc0e91e39c052 Mon Sep 17 00:00:00 2001 From: Jack Armitage Date: Wed, 20 Mar 2019 10:52:23 +0000 Subject: [PATCH] test doc structure --- docs/funcs.md | 23 +++++++++--------- docs/funcs_audio.md | 8 +++---- docs/funcs_color.md | 14 +++++------ docs/funcs_geometry.md | 54 ++++++++++++++++++++++++++++-------------- 4 files changed, 59 insertions(+), 40 deletions(-) diff --git a/docs/funcs.md b/docs/funcs.md index 702cb35..6e2fe4c 100644 --- a/docs/funcs.md +++ b/docs/funcs.md @@ -55,25 +55,25 @@ Functions for manipulating audio signals. `.setBins( bins )` -* `bins` :: integer (default x) +* `bins` :: integer (default `x`) ### setCutoff `.setCutoff( frequency )` -* `frequency` :: float (default x) +* `frequency` :: float (default `x`) ### setScale `.setScale( amount )` -* `amount` :: float (default x) +* `amount` :: float (default `x`) ### setSmooth `.setSmooth( amount )` -* `amount` :: float (default x) +* `amount` :: float (default `x`) ### show @@ -96,7 +96,7 @@ Functions for manipulating color. `.contrast( amount )` -* `amount` :: float (default 1.6) +* `amount` :: float (default `1.6`) Larger `amount` value makes higher contrast. @@ -114,7 +114,7 @@ Colorize texture. `.colorama( amount )` -* `amount` :: float (default 0.005) +* `amount` :: float (default `0.005`) Shift HSV values. @@ -122,7 +122,7 @@ Shift HSV values. `.invert( amount )` -* `amount` :: float (default 1.0) +* `amount` :: float (default `1.0`) Invert color. @@ -130,12 +130,13 @@ Invert color. `.luma( threshold, tolerance )` -* `threshold` :: float (default 0.5) -* `tolerance` :: float (default 0.1) +* `threshold` :: float (default `0.5`) +* `tolerance` :: float (default `0.1`) ### thresh `.thresh( threshold, tolerance )` -* `threshold` :: float (default 0.5) -* `tolerance` :: float (default 0.04) +* `threshold` :: float (default `0.5`) +* `tolerance` :: float (default `0.04`) + diff --git a/docs/funcs_audio.md b/docs/funcs_audio.md index 9518460..7d9aae6 100644 --- a/docs/funcs_audio.md +++ b/docs/funcs_audio.md @@ -17,25 +17,25 @@ Functions for manipulating audio signals. `.setBins( bins )` -* `bins` :: integer (default x) +* `bins` :: integer (default `x`) ### setCutoff `.setCutoff( frequency )` -* `frequency` :: float (default x) +* `frequency` :: float (default `x`) ### setScale `.setScale( amount )` -* `amount` :: float (default x) +* `amount` :: float (default `x`) ### setSmooth `.setSmooth( amount )` -* `amount` :: float (default x) +* `amount` :: float (default `x`) ### show diff --git a/docs/funcs_color.md b/docs/funcs_color.md index 3feb44a..60bee46 100644 --- a/docs/funcs_color.md +++ b/docs/funcs_color.md @@ -13,7 +13,7 @@ Functions for manipulating color. `.contrast( amount )` -* `amount` :: float (default 1.6) +* `amount` :: float (default `1.6`) Larger `amount` value makes higher contrast. @@ -31,7 +31,7 @@ Colorize texture. `.colorama( amount )` -* `amount` :: float (default 0.005) +* `amount` :: float (default `0.005`) Shift HSV values. @@ -39,7 +39,7 @@ Shift HSV values. `.invert( amount )` -* `amount` :: float (default 1.0) +* `amount` :: float (default `1.0`) Invert color. @@ -47,12 +47,12 @@ Invert color. `.luma( threshold, tolerance )` -* `threshold` :: float (default 0.5) -* `tolerance` :: float (default 0.1) +* `threshold` :: float (default `0.5`) +* `tolerance` :: float (default `0.1`) ### thresh `.thresh( threshold, tolerance )` -* `threshold` :: float (default 0.5) -* `tolerance` :: float (default 0.04) +* `threshold` :: float (default `0.5`) +* `tolerance` :: float (default `0.04`) diff --git a/docs/funcs_geometry.md b/docs/funcs_geometry.md index a5ac35e..e2324e4 100644 --- a/docs/funcs_geometry.md +++ b/docs/funcs_geometry.md @@ -2,43 +2,61 @@ Functions for manipulating geometry. -- [.kaleid( `nSides`)](#.kaleid( `nSides`)) -- [.rotate( `angle`, `speed` )](#.rotate( `angle`, `speed` )) -- [.scale( `size`, `xMult`, `yMult` )](#.scale( `size`, `xMult`, `yMult` )) -- [.pixelate( `x`, `y` )](#.pixelate( `x`, `y` )) -- [.scrollX( `scrollX`, `speed` )](#.scrollX( `scrollX`, `speed` )) -- [.scrollY( `scrollY`, `speed` )](#.scrollY( `scrollY`, `speed` )) +- [kaleid](#kaleid) +- [pixelate](#pixelate) +- [rotate](#rotate) +- [scale](#scale) +- [scrollX](#scrollX) +- [scrollY](#scrollY) --- -### .kaleid( `nSides`) -* nSides :: float (default 4.0) +### kaleid + +`.kaleid( nSides )` + +* `nSides` :: float (default `4.0`) Kaleidoscope effect with `nSides` repetition. -### .rotate( `angle`, `speed` ) -* angle :: float (default 10.0) -* speed :: float (default 0.0) +### pixelate + +`.pixelate( x, y )` + +* `pixelX` :: float (default `20.0`) +* `pixelY` :: float (default `20.0`) + +Pixelate texture with `pixelX` segments and `pixelY` segments. + +### rotate + +`.rotate( angle, speed )` + +* `angle` :: float (default `10.0`) +* `speed` :: float (default `0.0`) Rotate texture. -### .scale( `size`, `xMult`, `yMult` ) +### scale + +`.scale( `size`, `xMult`, `yMult` )` + * size :: float * xMult :: float (default 1.0) * yMult :: float (default 1.0) Scale texture. -### .pixelate( `x`, `y` ) -* pixelX :: float (default 20.0) -* pixelY :: float (default 20.0) +### scrollX -Pixelate texture with `pixelX` segments and `pixelY` segments. +`.scrollX( `scrollX`, `speed` )` -### .scrollX( `scrollX`, `speed` ) * scrollX :: float (default 0.5) * speed :: float (default 0.0) -### .scrollY( `scrollY`, `speed` ) +### scrollY + +`.scrollY( `scrollY`, `speed` )` + * scrollY :: float (default 0.5) * speed :: float (default 0.0) \ No newline at end of file