re-generated documentation

arturo-lang · May 13, 2021 · 93d13f9 · 93d13f9
1 parent 94b89d9
commit 93d13f9
Show file tree

Hide file tree

Showing 24 changed files with 187 additions and 31 deletions.
diff --git a/docs/website/data/libraryFunctions.art b/docs/website/data/libraryFunctions.art
@@ -73,6 +73,8 @@
  	"reflection/benchmark"
  	"binary?"
  	"reflection/binary-"
+ 	"blend"
+ 	"colors/blend"
  	"block?"
  	"reflection/block-"
  	"boolean?"
@@ -122,7 +124,7 @@
  	"cursor"
  	"io/cursor"
  	"darken"
- 	"color/darken"
+ 	"colors/darken"
  	"database?"
  	"reflection/database-"
  	"date?"
@@ -135,6 +137,8 @@
  	"converters/define"
  	"delete"
  	"files/delete"
+ 	"desaturate"
+ 	"colors/desaturate"
  	"deviation"
  	"statistics/deviation"
  	"dictionary"
@@ -259,6 +263,8 @@
  	"reflection/integer-"
  	"intersection"
  	"sets/intersection"
+ 	"invert"
+ 	"colors/invert"
  	"is?"
  	"reflection/is-"
  	"join"
@@ -284,7 +290,7 @@
  	"levenshtein"
  	"strings/levenshtein"
  	"lighten"
- 	"color/lighten"
+ 	"colors/lighten"
  	"list"
  	"paths/list"
  	"literal?"
@@ -427,6 +433,8 @@
  	"numbers/round"
  	"sample"
  	"collections/sample"
+ 	"saturate"
+ 	"colors/saturate"
  	"script"
  	"system/script"
  	"sec"

diff --git a/docs/website/data/libraryModules.art b/docs/website/data/libraryModules.art
@@ -2,7 +2,7 @@
 	"Arithmetic"
  	"Binary"
  	"Collections"
- 	"Color"
+ 	"Colors"
  	"Comparison"
  	"Converters"
  	"Core"

diff --git a/docs/website/pages/documentation/library/collections/append.art b/docs/website/pages/documentation/library/collections/append.art
@@ -42,5 +42,5 @@ related: [
         "Binary/and"
          "Collections/extend"
          "Collections/remove"
-         "Databases/open"
+         "Colors/blend"
     ]
diff --git a/docs/website/pages/documentation/library/collections/extend.art b/docs/website/pages/documentation/library/collections/extend.art
@@ -23,7 +23,7 @@ arguments: #[
     ]
 related: [
         "Collections/append"
+         "Colors/blend"
          "Numbers/even?"
          "Binary/and"
-         "Binary/nand"
     ]
diff --git a/docs/website/pages/documentation/library/collections/flatten.art b/docs/website/pages/documentation/library/collections/flatten.art
@@ -36,6 +36,6 @@ arguments: #[
 related: [
         "Iterators/fold"
          "Collections/last"
-         "Color/darken"
-         "Color/lighten"
+         "Colors/darken"
+         "Colors/lighten"
     ]
diff --git a/docs/website/pages/documentation/library/collections/insert.art b/docs/website/pages/documentation/library/collections/insert.art
@@ -40,8 +40,8 @@ arguments: #[
         ]
     ]
 related: [
-        "Reflection/inspect"
+        "Colors/invert"
+         "Reflection/inspect"
          "Strings/indent"
          "Collections/index"
-         "Collections/set"
     ]
diff --git a/docs/website/pages/documentation/library/collections/permutate.art b/docs/website/pages/documentation/library/collections/permutate.art
@@ -17,8 +17,8 @@ arguments: #[
         ]
     ]
 related: [
-        "Io/terminal"
+        "Colors/desaturate"
+         "Colors/saturate"
+         "Io/terminal"
          "Strings/truncate"
-         "Collections/empty"
-         "Collections/empty?"
     ]
diff --git a/...es/documentation/library/color/_index.art → ...s/documentation/library/colors/_index.art b/...es/documentation/library/color/_index.art → ...s/documentation/library/colors/_index.art
diff --git a/docs/website/pages/documentation/library/colors/blend.art b/docs/website/pages/documentation/library/colors/blend.art
@@ -0,0 +1,30 @@
+name: "blend"
+type: :function
+module: "Colors"
+returns: [
+        :color
+    ]
+description: "blend given colors and get result"
+example: ""
+attributes: #[
+    balance: #[
+        types: [
+                :floating
+            ]
+        description: "use different mix of color (0.0-1.0, default:0.5)"
+        ]
+    ]
+arguments: #[
+    colorA: [
+            :color
+        ]
+    colorB: [
+            :color
+        ]
+    ]
+related: [
+        "Binary/and"
+         "Binary/nand"
+         "Collections/append"
+         "Collections/extend"
+    ]
diff --git a/...es/documentation/library/color/darken.art → ...s/documentation/library/colors/darken.art b/...es/documentation/library/color/darken.art → ...s/documentation/library/colors/darken.art
@@ -1,10 +1,10 @@
 name: "darken"
 type: :function
-module: "Color"
+module: "Colors"
 returns: [
         :color
     ]
-description: "darken color by given percentage (0.0-0.1)"
+description: "darken color by given percentage (0.0-1.0)"
 example: ""
 attributes: #[
     ]
@@ -17,8 +17,8 @@ arguments: #[
         ]
     ]
 related: [
-        "Color/lighten"
+        "Colors/lighten"
+         "Colors/saturate"
+         "Colors/desaturate"
          "Collections/take"
-         "Reflection/date?"
-         "Arithmetic/dec"
     ]
diff --git a/docs/website/pages/documentation/library/colors/desaturate.art b/docs/website/pages/documentation/library/colors/desaturate.art
@@ -0,0 +1,24 @@
+name: "desaturate"
+type: :function
+module: "Colors"
+returns: [
+        :color
+    ]
+description: "desaturate color by given percentage (0.0-1.0)"
+example: ""
+attributes: #[
+    ]
+arguments: #[
+    color: [
+            :color
+        ]
+    percent: [
+            :floating
+        ]
+    ]
+related: [
+        "Colors/saturate"
+         "Colors/darken"
+         "Colors/lighten"
+         "Collections/permutate"
+    ]
diff --git a/docs/website/pages/documentation/library/colors/invert.art b/docs/website/pages/documentation/library/colors/invert.art
@@ -0,0 +1,21 @@
+name: "invert"
+type: :function
+module: "Colors"
+returns: [
+        :color
+    ]
+description: "get complement for given color"
+example: ""
+attributes: #[
+    ]
+arguments: #[
+    color: [
+            :color
+        ]
+    ]
+related: [
+        "Collections/insert"
+         "Strings/indent"
+         "Collections/index"
+         "Io/input"
+    ]
diff --git a/...s/documentation/library/color/lighten.art → .../documentation/library/colors/lighten.art b/...s/documentation/library/color/lighten.art → .../documentation/library/colors/lighten.art
@@ -1,10 +1,10 @@
 name: "lighten"
 type: :function
-module: "Color"
+module: "Colors"
 returns: [
         :color
     ]
-description: "lighten color by given percentage (0.0-0.1)"
+description: "lighten color by given percentage (0.0-1.0)"
 example: ""
 attributes: #[
     ]
@@ -17,8 +17,8 @@ arguments: #[
         ]
     ]
 related: [
-        "Color/darken"
+        "Colors/darken"
+         "Colors/saturate"
+         "Colors/desaturate"
          "Collections/flatten"
-         "Iterators/filter"
-         "Paths/list"
     ]
diff --git a/docs/website/pages/documentation/library/colors/saturate.art b/docs/website/pages/documentation/library/colors/saturate.art
@@ -0,0 +1,24 @@
+name: "saturate"
+type: :function
+module: "Colors"
+returns: [
+        :color
+    ]
+description: "saturate color by given percentage (0.0-1.0)"
+example: ""
+attributes: #[
+    ]
+arguments: #[
+    color: [
+            :color
+        ]
+    percent: [
+            :floating
+        ]
+    ]
+related: [
+        "Colors/desaturate"
+         "Colors/darken"
+         "Colors/lighten"
+         "Statistics/average"
+    ]
diff --git a/docs/website/pages/documentation/library/converters/to.art b/docs/website/pages/documentation/library/converters/to.art
@@ -54,6 +54,12 @@ attributes: #[
             ]
         description: "use given format (for dates)"
         ]
+    hsl: #[
+        types: [
+                :boolean
+            ]
+        description: "convert HSL block to color"
+        ]
     ]
 arguments: #[
     type: [

diff --git a/docs/website/pages/documentation/library/core/break.art b/docs/website/pages/documentation/library/core/break.art
@@ -26,7 +26,7 @@ arguments: #[
     ]
 related: [
         "Files/read"
+         "Colors/blend"
          "Converters/array"
          "Io/clear"
-         "Arithmetic/dec"
     ]
diff --git a/docs/website/pages/documentation/library/core/when-.art b/docs/website/pages/documentation/library/core/when-.art
@@ -26,5 +26,5 @@ related: [
         "Numbers/even?"
          "Collections/in?"
          "Collections/key?"
-         "Core/while"
+         "Colors/blend"
     ]
diff --git a/docs/website/pages/documentation/library/io/clear.art b/docs/website/pages/documentation/library/io/clear.art
@@ -11,8 +11,8 @@ attributes: #[
 arguments: #[
     ]
 related: [
-        "Core/break"
+        "Colors/blend"
+         "Core/break"
          "Core/let"
          "Core/var"
-         "Databases/close"
     ]
diff --git a/docs/website/pages/documentation/library/numbers/round.art b/docs/website/pages/documentation/library/numbers/round.art
@@ -32,5 +32,5 @@ related: [
         "Arithmetic/mod"
          "Binary/and"
          "Binary/nand"
-         "Files/read"
+         "Colors/blend"
     ]
diff --git a/docs/website/pages/documentation/library/paths/extract.art b/docs/website/pages/documentation/library/paths/extract.art
@@ -104,10 +104,53 @@ attributes: #[
             ]
         description: "get anchor field from URL"
         ]
+    red: #[
+        types: [
+                :boolean
+            ]
+        description: "get red component from color"
+        ]
+    green: #[
+        types: [
+                :boolean
+            ]
+        description: "get green component from color"
+        ]
+    blue: #[
+        types: [
+                :boolean
+            ]
+        description: "get blue component from color"
+        ]
+    hsl: #[
+        types: [
+                :boolean
+            ]
+        description: "get HSL representation from color"
+        ]
+    hue: #[
+        types: [
+                :boolean
+            ]
+        description: "get hue component from color"
+        ]
+    saturation: #[
+        types: [
+                :boolean
+            ]
+        description: "get saturation component from color"
+        ]
+    luminosity: #[
+        types: [
+                :boolean
+            ]
+        description: "get luminosity component from color"
+        ]
     ]
 arguments: #[
     path: [
             :string
+             :color
         ]
     ]
 related: [

diff --git a/docs/website/pages/documentation/library/reflection/inspect.art b/docs/website/pages/documentation/library/reflection/inspect.art
@@ -26,7 +26,7 @@ arguments: #[
     ]
 related: [
         "Collections/insert"
+         "Colors/invert"
          "Io/input"
          "Strings/indent"
-         "Arithmetic/inc"
     ]
diff --git a/docs/website/pages/documentation/library/statistics/average.art b/docs/website/pages/documentation/library/statistics/average.art
@@ -19,6 +19,6 @@ arguments: #[
 related: [
         "Statistics/median"
          "Collections/reverse"
+         "Colors/saturate"
          "Converters/array"
-         "Files/rename"
     ]