Merge pull request #2925 from quantified-uncertainty/api-deprecate-ti…

…tles-Tag.all Deprecate Plot Titles, Tag.all -> Tag.getAll
quantified-uncertainty · Jan 9, 2024 · 152df1a · 152df1a · vercel · Jan 9, 2024
2 parents ff5fafb + 7c290ab
commit 152df1a
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 14 deletions.
diff --git a/.changeset/curvy-peaches-matter.md b/.changeset/curvy-peaches-matter.md
@@ -0,0 +1,5 @@
+---
+"@quri/squiggle-lang": patch
+---
+
+Breaking: Deprecates Plot titles, changes Tag.all -> Tag.getAll
diff --git a/packages/squiggle-lang/__tests__/library/tag_test.ts b/packages/squiggle-lang/__tests__/library/tag_test.ts
@@ -11,7 +11,7 @@ describe("Tags", () => {
 
   describe("all", () => {
     testEvalToBe(
-      "123 -> Tag.name('myName') -> Tag.doc('myDoc') -> Tag.all",
+      "123 -> Tag.name('myName') -> Tag.doc('myDoc') -> Tag.getAll",
       '{name: "myName",doc: "myDoc"}'
     );
   });
@@ -22,14 +22,14 @@ describe("Tags", () => {
 
   describe("omit", () => {
     testEvalToBe(
-      "123 -> Tag.name('myName') -> Tag.doc('myDoc') -> Tag.format('.2%') -> Tag.omit(['name', 'doc']) -> Tag.all",
+      "123 -> Tag.name('myName') -> Tag.doc('myDoc') -> Tag.format('.2%') -> Tag.omit(['name', 'doc']) -> Tag.getAll",
       '{numberFormat: ".2%"}'
     );
   });
 
   describe("clear", () => {
     testEvalToBe(
-      "123 -> Tag.name('myName') -> Tag.doc('myDoc') -> Tag.format('.2%') -> Tag.clear -> Tag.all",
+      "123 -> Tag.name('myName') -> Tag.doc('myDoc') -> Tag.format('.2%') -> Tag.clear -> Tag.getAll",
       "{}"
     );
   });

diff --git a/packages/squiggle-lang/src/fr/plot.ts b/packages/squiggle-lang/src/fr/plot.ts
@@ -5,6 +5,7 @@ import { makeDefinition } from "../library/registry/fnDefinition.js";
 import {
   frArray,
   frBool,
+  frDeprecated,
   frDict,
   frDist,
   frDistOrNumber,
@@ -183,7 +184,7 @@ const numericFnDef = () => {
               frDict(
                 ["xScale", frOptional(frScale)],
                 ["yScale", frOptional(frScale)],
-                ["title", frOptional(frString)],
+                ["title", frDeprecated(frOptional(frString))],
                 ["xPoints", frOptional(frArray(frNumber))]
               )
             )
@@ -207,7 +208,7 @@ const numericFnDef = () => {
             ["fn", fnType],
             ["xScale", frOptional(frScale)],
             ["yScale", frOptional(frScale)],
-            ["title", frOptional(frString)],
+            ["title", frDeprecated(frOptional(frString))],
             ["xPoints", frOptional(frArray(frNumber))]
           ),
         ],
@@ -251,7 +252,7 @@ export const library = [
               frDict(
                 ["xScale", frOptional(frScale)],
                 ["yScale", frOptional(frScale)],
-                ["title", frOptional(frString)],
+                ["title", frDeprecated(frOptional(frString))],
                 ["showSummary", frOptional(frBool)]
               )
             )
@@ -276,7 +277,7 @@ export const library = [
             ["dist", frDist],
             ["xScale", frOptional(frScale)],
             ["yScale", frOptional(frScale)],
-            ["title", frOptional(frString)],
+            ["title", frDeprecated(frOptional(frString))],
             ["showSummary", frOptional(frBool)]
           ),
         ],
@@ -329,7 +330,7 @@ export const library = [
             frDict(
               ["xScale", frOptional(frScale)],
               ["yScale", frOptional(frScale)],
-              ["title", frOptional(frString)],
+              ["title", frDeprecated(frOptional(frString))],
               ["showSummary", frOptional(frBool)]
             )
           ),
@@ -373,7 +374,7 @@ export const library = [
             ],
             ["xScale", frOptional(frScale)],
             ["yScale", frOptional(frScale)],
-            ["title", frOptional(frString)],
+            ["title", frDeprecated(frOptional(frString))],
             ["showSummary", frOptional(frBool)]
           ),
         ],
@@ -426,7 +427,7 @@ export const library = [
                 ["xScale", frOptional(frScale)],
                 ["yScale", frOptional(frScale)],
                 ["distXScale", frOptional(frScale)],
-                ["title", frOptional(frString)],
+                ["title", frDeprecated(frOptional(frString))],
                 ["xPoints", frOptional(frArray(frNumber))]
               )
             )
@@ -456,7 +457,7 @@ export const library = [
             ["xScale", frOptional(frScale)],
             ["yScale", frOptional(frScale)],
             ["distXScale", frOptional(frScale)],
-            ["title", frOptional(frString)],
+            ["title", frDeprecated(frOptional(frString))],
             ["xPoints", frOptional(frArray(frNumber))]
           ),
         ],
@@ -507,7 +508,7 @@ Plot.scatter({
             ["yDist", frWithTags(frSampleSetDist)],
             ["xScale", frOptional(frScale)],
             ["yScale", frOptional(frScale)],
-            ["title", frOptional(frString)]
+            ["title", frDeprecated(frOptional(frString))]
           ),
         ],
         frPlot,

diff --git a/packages/squiggle-lang/src/fr/relativeValues.ts b/packages/squiggle-lang/src/fr/relativeValues.ts
@@ -2,6 +2,7 @@ import { sq } from "../index.js";
 import { makeDefinition } from "../library/registry/fnDefinition.js";
 import {
   frArray,
+  frDeprecated,
   frDict,
   frLambdaTyped,
   frNumber,
@@ -21,7 +22,7 @@ const maker = new FnFactory({
 const relativeValuesShape = frDict(
   ["ids", frArray(frString)],
   ["fn", frLambdaTyped([frString, frString], frArray(frNumber))],
-  ["title", frOptional(frString)]
+  ["title", frDeprecated(frOptional(frString))]
 );
 
 export const library = [

diff --git a/packages/squiggle-lang/src/fr/tag.ts b/packages/squiggle-lang/src/fr/tag.ts
@@ -265,7 +265,7 @@ Different types of values can be displayed in different ways. The following tabl
     ],
   }),
   maker.make({
-    name: "all",
+    name: "getAll",
     displaySection: "Functions",
     description: "Returns a dictionary of all tags on a value.",
     definitions: [

diff --git a/packages/squiggle-lang/src/library/registry/frTypes.ts b/packages/squiggle-lang/src/library/registry/frTypes.ts
@@ -55,6 +55,10 @@ export const isOptional = <T>(frType: FRType<T>): boolean => {
   return frType.isOptional === undefined ? false : frType.isOptional;
 };
 
+export const isDeprecated = <T>(frType: FRType<T>): boolean => {
+  return frType.tag === "deprecated";
+};
+
 export const frNumber: FRType<number> = {
   unpack: (v: Value) => (v.type === "Number" ? v.value : undefined),
   pack: (v) => vNumber(v),
@@ -552,6 +556,7 @@ export function frDict<T extends object>(
     display: () =>
       "{" +
       allKvs
+        .filter(([_, frType]) => !isDeprecated(frType))
         .map(
           ([name, frType]) =>
             `${name}${isOptional(frType) ? "?" : ""}: ${frType.display()}`
@@ -596,3 +601,14 @@ export const frOptional = <T>(itemType: FRType<T>): FRType<T | null> => {
     fieldType: itemType.fieldType,
   };
 };
+
+export const frDeprecated = <T>(itemType: FRType<T>): FRType<T> => ({
+  unpack: itemType.unpack,
+  pack: (v) => itemType.pack(v),
+  display: () => ``,
+  isOptional: isOptional(itemType),
+  tag: "deprecated",
+  underlyingType: itemType,
+  default: itemType.default,
+  fieldType: itemType.fieldType,
+});