fixing up documentation warnings

swiftviz · May 28, 2022 · 62104f0 · 62104f0
1 parent 0bed54e
commit 62104f0
Show file tree

Hide file tree

Showing 95 changed files with 36,203 additions and 18,391 deletions.
diff --git a/Sources/SwiftVizScale/Documentation.docc/AnyContinuousScale.md b/Sources/SwiftVizScale/Documentation.docc/AnyContinuousScale.md
@@ -59,5 +59,5 @@
 - ``SwiftVizScale/AnyContinuousScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-5edrw``
 - ``SwiftVizScale/AnyContinuousScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-88d9h``
 - ``SwiftVizScale/AnyContinuousScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-8fm66``
-- ``SwiftVizScale/AnyContinuousScale/ticksFromValues(_:from:to:formatter:)``
+- ``SwiftVizScale/AnyContinuousScale/ticksFromValues(_:reversed:from:to:formatter:)``
 - ``SwiftVizScale/AnyContinuousScale/validTickValues(_:formatter:)``
diff --git a/Sources/SwiftVizScale/Documentation.docc/ContinuousScale.md b/Sources/SwiftVizScale/Documentation.docc/ContinuousScale.md
@@ -59,6 +59,6 @@
 - ``SwiftVizScale/ContinuousScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-4k3lb``
 - ``SwiftVizScale/ContinuousScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-67z4e``
 - ``SwiftVizScale/ContinuousScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-73yzr``
-- ``SwiftVizScale/ContinuousScale/ticksFromValues(_:from:to:formatter:)``
+- ``SwiftVizScale/ContinuousScale/ticksFromValues(_:reversed:from:to:formatter:)``
 - ``SwiftVizScale/ContinuousScale/validTickValues(_:formatter:)``
 
diff --git a/Sources/SwiftVizScale/Documentation.docc/LinearScale.md b/Sources/SwiftVizScale/Documentation.docc/LinearScale.md
@@ -60,5 +60,5 @@
 - ``SwiftVizScale/LinearScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-4kac6``
 - ``SwiftVizScale/LinearScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-4qnov``
 - ``SwiftVizScale/LinearScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-zvvj``
-- ``SwiftVizScale/LinearScale/ticksFromValues(_:from:to:formatter:)``
+- ``SwiftVizScale/LinearScale/ticksFromValues(_:reversed:from:to:formatter:)``
 - ``SwiftVizScale/LinearScale/validTickValues(_:formatter:)``
diff --git a/Sources/SwiftVizScale/Documentation.docc/LogScale.md b/Sources/SwiftVizScale/Documentation.docc/LogScale.md
@@ -63,5 +63,5 @@
 - ``SwiftVizScale/LogScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-2eo1i``
 - ``SwiftVizScale/LogScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-3xdc2``
 - ``SwiftVizScale/LogScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-7y98y``
-- ``SwiftVizScale/LogScale/ticksFromValues(_:from:to:formatter:)``
+- ``SwiftVizScale/LogScale/ticksFromValues(_:reversed:from:to:formatter:)``
 - ``SwiftVizScale/LogScale/validTickValues(_:formatter:)``
diff --git a/Sources/SwiftVizScale/Documentation.docc/PowerScale.md b/Sources/SwiftVizScale/Documentation.docc/PowerScale.md
@@ -65,5 +65,5 @@
 - ``SwiftVizScale/PowerScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-5op8i``
 - ``SwiftVizScale/PowerScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-8y59b``
 - ``SwiftVizScale/PowerScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-9en4k``
-- ``SwiftVizScale/PowerScale/ticksFromValues(_:from:to:formatter:)``
+- ``SwiftVizScale/PowerScale/ticksFromValues(_:reversed:from:to:formatter:)``
 - ``SwiftVizScale/PowerScale/validTickValues(_:formatter:)``
diff --git a/Sources/SwiftVizScale/Documentation.docc/RadialScale.md b/Sources/SwiftVizScale/Documentation.docc/RadialScale.md
@@ -60,5 +60,5 @@
 - ``SwiftVizScale/RadialScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-3de4p``
 - ``SwiftVizScale/RadialScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-6agip``
 - ``SwiftVizScale/RadialScale/ticks(reversed:rangeLower:rangeHigher:formatter:)-twb3``
-- ``SwiftVizScale/RadialScale/ticksFromValues(_:from:to:formatter:)``
+- ``SwiftVizScale/RadialScale/ticksFromValues(_:reversed:from:to:formatter:)``
 - ``SwiftVizScale/RadialScale/validTickValues(_:formatter:)``
diff --git a/Sources/SwiftVizScale/LinearScale.swift b/Sources/SwiftVizScale/LinearScale.swift
@@ -29,7 +29,7 @@ public struct LinearScale<InputType: ConvertibleWithDouble & NiceValue, OutputTy
 
     /// The number of ticks desired when creating the scale.
     ///
-    /// This number may not match the number of ticks returned by ``ContinuousScale/ticksFromValues(_:from:to:formatter:)``
+    /// This number may not match the number of ticks returned by ``ContinuousScale/ticksFromValues(_:reversed:from:to:formatter:)``
     public let desiredTicks: Int
 
     /// Creates a new linear scale for the upper and lower bounds of the domain you provide.

diff --git a/Sources/SwiftVizScale/LogScale.swift b/Sources/SwiftVizScale/LogScale.swift
@@ -34,7 +34,7 @@ public struct LogScale<InputType: ConvertibleWithDouble & NiceValue, OutputType:
 
     /// The number of ticks desired when creating the scale.
     ///
-    /// This number may not match the number of ticks returned by ``LogScale/ticksFromValues(_:from:to:formatter:)``
+    /// This number may not match the number of ticks returned by ``LogScale/ticksFromValues(_:reversed:from:to:formatter:)``
     public let desiredTicks: Int
 
     /// Creates a new logarithmic scale for the upper and lower bounds of the domain you provide.

diff --git a/Sources/SwiftVizScale/PowerScale.swift b/Sources/SwiftVizScale/PowerScale.swift
@@ -38,7 +38,7 @@ public struct PowerScale<InputType: ConvertibleWithDouble & NiceValue, OutputTyp
 
     /// The number of ticks desired when creating the scale.
     ///
-    /// This number may not match the number of ticks returned by ``PowerScale/ticksFromValues(_:from:to:formatter:)``
+    /// This number may not match the number of ticks returned by ``PowerScale/ticksFromValues(_:reversed:from:to:formatter:)``
     public let desiredTicks: Int
 
     /// The exponent value of the scale.

diff --git a/Sources/SwiftVizScale/RadialScale.swift b/Sources/SwiftVizScale/RadialScale.swift
@@ -36,7 +36,7 @@ public struct RadialScale<InputType: ConvertibleWithDouble & NiceValue, OutputTy
 
     /// The number of ticks desired when creating the scale.
     ///
-    /// This number may not match the number of ticks returned by ``RadialScale/ticksFromValues(_:from:to:formatter:)``
+    /// This number may not match the number of ticks returned by ``RadialScale/ticksFromValues(_:reversed:from:to:formatter:)``
     public let desiredTicks: Int
 
     /// Creates a new linear scale for the upper and lower bounds of the domain you provide.

diff --git a/docs/data/documentation/swiftvizscale/anycontinuousscale.json b/docs/data/documentation/swiftvizscale/anycontinuousscale.json
@@ -297,6 +297,7 @@
         "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/ticks(reversed:rangeLower:rangeHigher:formatter:)-5edrw",
         "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/ticks(reversed:rangeLower:rangeHigher:formatter:)-88d9h",
         "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/ticks(reversed:rangeLower:rangeHigher:formatter:)-8fm66",
+        "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/ticksFromValues(_:reversed:from:to:formatter:)",
         "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/validTickValues(_:formatter:)"
       ],
       "title" : "Creating Ticks"
@@ -3533,6 +3534,133 @@
   "type" : "topic",
   "url" : "\/documentation\/swiftvizscale\/anycontinuousscale\/ticks(reversed:rangelower:rangehigher:formatter:)-8fm66"
 },
+"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/AnyContinuousScale/ticksFromValues(_:reversed:from:to:formatter:)": {
+  "abstract" : [
+    {
+      "text" : "Converts an array of values that matches the scale’s input type to a list of ticks that are within the scale’s domain.",
+      "type" : "text"
+    }
+  ],
+  "fragments" : [
+    {
+      "kind" : "keyword",
+      "text" : "func"
+    },
+    {
+      "kind" : "text",
+      "text" : " "
+    },
+    {
+      "kind" : "identifier",
+      "text" : "ticksFromValues"
+    },
+    {
+      "kind" : "text",
+      "text" : "(["
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:13SwiftVizScale0C0P9InputTypeQa",
+      "text" : "InputType"
+    },
+    {
+      "kind" : "text",
+      "text" : "], "
+    },
+    {
+      "kind" : "externalParam",
+      "text" : "reversed"
+    },
+    {
+      "kind" : "text",
+      "text" : ": "
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:Sb",
+      "text" : "Bool"
+    },
+    {
+      "kind" : "text",
+      "text" : ", "
+    },
+    {
+      "kind" : "externalParam",
+      "text" : "from"
+    },
+    {
+      "kind" : "text",
+      "text" : ": "
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:13SwiftVizScale0C0P10OutputTypeQa",
+      "text" : "OutputType"
+    },
+    {
+      "kind" : "text",
+      "text" : ", "
+    },
+    {
+      "kind" : "externalParam",
+      "text" : "to"
+    },
+    {
+      "kind" : "text",
+      "text" : ": "
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:13SwiftVizScale0C0P10OutputTypeQa",
+      "text" : "OutputType"
+    },
+    {
+      "kind" : "text",
+      "text" : ", "
+    },
+    {
+      "kind" : "externalParam",
+      "text" : "formatter"
+    },
+    {
+      "kind" : "text",
+      "text" : ": "
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "c:objc(cs)NSFormatter",
+      "text" : "Formatter"
+    },
+    {
+      "kind" : "text",
+      "text" : "?) -> ["
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:13SwiftVizScale4TickV",
+      "text" : "Tick"
+    },
+    {
+      "kind" : "text",
+      "text" : "<"
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:13SwiftVizScale0C0P10OutputTypeQa",
+      "text" : "OutputType"
+    },
+    {
+      "kind" : "text",
+      "text" : ">]"
+    }
+  ],
+  "identifier" : "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/ticksFromValues(_:reversed:from:to:formatter:)",
+  "kind" : "symbol",
+  "role" : "symbol",
+  "title" : "ticksFromValues(_:reversed:from:to:formatter:)",
+  "type" : "topic",
+  "url" : "\/documentation\/swiftvizscale\/anycontinuousscale\/ticksfromvalues(_:reversed:from:to:formatter:)"
+},
 "doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/AnyContinuousScale/transform(_:)": {
   "abstract" : [
     {

diff --git a/...tion/swiftvizscale/anycontinuousscale/ticks(rangelower:rangehigher:formatter:)-53t2s.json b/...tion/swiftvizscale/anycontinuousscale/ticks(rangelower:rangehigher:formatter:)-53t2s.json
@@ -327,6 +327,7 @@
         "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/ticks(reversed:rangeLower:rangeHigher:formatter:)-5edrw",
         "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/ticks(reversed:rangeLower:rangeHigher:formatter:)-88d9h",
         "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/ticks(reversed:rangeLower:rangeHigher:formatter:)-8fm66",
+        "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/ticksFromValues(_:reversed:from:to:formatter:)",
         "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/validTickValues(_:formatter:)"
       ],
       "title" : "Creating Ticks"
@@ -1537,6 +1538,133 @@
   "type" : "topic",
   "url" : "\/documentation\/swiftvizscale\/anycontinuousscale\/ticks(reversed:rangelower:rangehigher:formatter:)-8fm66"
 },
+"doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/AnyContinuousScale/ticksFromValues(_:reversed:from:to:formatter:)": {
+  "abstract" : [
+    {
+      "text" : "Converts an array of values that matches the scale’s input type to a list of ticks that are within the scale’s domain.",
+      "type" : "text"
+    }
+  ],
+  "fragments" : [
+    {
+      "kind" : "keyword",
+      "text" : "func"
+    },
+    {
+      "kind" : "text",
+      "text" : " "
+    },
+    {
+      "kind" : "identifier",
+      "text" : "ticksFromValues"
+    },
+    {
+      "kind" : "text",
+      "text" : "(["
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:13SwiftVizScale0C0P9InputTypeQa",
+      "text" : "InputType"
+    },
+    {
+      "kind" : "text",
+      "text" : "], "
+    },
+    {
+      "kind" : "externalParam",
+      "text" : "reversed"
+    },
+    {
+      "kind" : "text",
+      "text" : ": "
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:Sb",
+      "text" : "Bool"
+    },
+    {
+      "kind" : "text",
+      "text" : ", "
+    },
+    {
+      "kind" : "externalParam",
+      "text" : "from"
+    },
+    {
+      "kind" : "text",
+      "text" : ": "
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:13SwiftVizScale0C0P10OutputTypeQa",
+      "text" : "OutputType"
+    },
+    {
+      "kind" : "text",
+      "text" : ", "
+    },
+    {
+      "kind" : "externalParam",
+      "text" : "to"
+    },
+    {
+      "kind" : "text",
+      "text" : ": "
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:13SwiftVizScale0C0P10OutputTypeQa",
+      "text" : "OutputType"
+    },
+    {
+      "kind" : "text",
+      "text" : ", "
+    },
+    {
+      "kind" : "externalParam",
+      "text" : "formatter"
+    },
+    {
+      "kind" : "text",
+      "text" : ": "
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "c:objc(cs)NSFormatter",
+      "text" : "Formatter"
+    },
+    {
+      "kind" : "text",
+      "text" : "?) -> ["
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:13SwiftVizScale4TickV",
+      "text" : "Tick"
+    },
+    {
+      "kind" : "text",
+      "text" : "<"
+    },
+    {
+      "kind" : "typeIdentifier",
+      "preciseIdentifier" : "s:13SwiftVizScale0C0P10OutputTypeQa",
+      "text" : "OutputType"
+    },
+    {
+      "kind" : "text",
+      "text" : ">]"
+    }
+  ],
+  "identifier" : "doc:\/\/com.github.swiftviz.SwiftVizScale\/documentation\/SwiftVizScale\/AnyContinuousScale\/ticksFromValues(_:reversed:from:to:formatter:)",
+  "kind" : "symbol",
+  "role" : "symbol",
+  "title" : "ticksFromValues(_:reversed:from:to:formatter:)",
+  "type" : "topic",
+  "url" : "\/documentation\/swiftvizscale\/anycontinuousscale\/ticksfromvalues(_:reversed:from:to:formatter:)"
+},
 "doc://com.github.swiftviz.SwiftVizScale/documentation/SwiftVizScale/AnyContinuousScale/validTickValues(_:formatter:)": {
   "abstract" : [
     {