expand descriptions

iterative · Sep 9, 2022 · ffadaa9 · ffadaa9
1 parent 9152c89
commit ffadaa9
Showing 1 changed file with 10 additions and 10 deletions.
diff --git a/schema.json b/schema.json
@@ -4,7 +4,7 @@
   "properties": {
     "vars": {
       "title": "Variables",
-      "description": "Variables for the parametrization",
+      "description": "Sequence of variables for parametrization.\n\nMay include any mapping or a path to a params file\n(which can be a string or a mapping to params in the file).\n\nUse elsewhere in `dvc.yaml` with the `${}` substitution expression.",
       "allOf": [
         {
           "$ref": "#/definitions/Vars"
@@ -13,7 +13,7 @@
     },
     "stages": {
       "title": "Stages",
-      "description": "List of stages",
+      "description": "Sequence of stages that form a pipeline.",
       "type": "object",
       "additionalProperties": {
         "oneOf": [
@@ -328,7 +328,7 @@
       "properties": {
         "cmd": {
           "title": "Cmd",
-          "description": "Command to run",
+          "description": "(Required) Command to run (anything your system terminal can run).\nCan be a string or a sequence of commands.",
           "anyOf": [
             {
               "type": "string"
@@ -343,12 +343,12 @@
         },
         "wdir": {
           "title": "Wdir",
-          "description": "Working directory",
+          "description": "Working directory for the cmd, relative to `dvc.yaml`.",
           "type": "string"
         },
         "deps": {
           "title": "Deps",
-          "description": "Dependencies for the stage",
+          "description": "Sequence of the dependencies for the stage.",
           "allOf": [
             {
               "$ref": "#/definitions/Dependencies"
@@ -357,7 +357,7 @@
         },
         "params": {
           "title": "Params",
-          "description": "Params for the stage",
+          "description": "Sequence of dot-separated parameter dependency keys to track from `params.yaml`.\n\nMay contain other YAML/JSON/TOML/Python parameter file names, with a\nsub-sequence of the param names to track in them (leave empty to include all).",
           "allOf": [
             {
               "$ref": "#/definitions/Params"
@@ -366,7 +366,7 @@
         },
         "outs": {
           "title": "Outs",
-          "description": "Outputs of the stage",
+          "description": "Sequence of the outputs of the stage.",
           "allOf": [
             {
               "$ref": "#/definitions/Outs"
@@ -375,7 +375,7 @@
         },
         "metrics": {
           "title": "Metrics",
-          "description": "Metrics of the stage",
+          "description": "Sequence of metrics of the stage written to JSON/TOML/YAML for evaluation.",
           "allOf": [
             {
               "$ref": "#/definitions/Outs"
@@ -384,7 +384,7 @@
         },
         "plots": {
           "title": "Plots",
-          "description": "Plots of the stage",
+          "description": "Sequence of plots of the stage for visualization.\nPlots may be written to JSON/YAML/CSV/TSV for data or JPEG/GIF/PNG for images.",
           "allOf": [
             {
               "$ref": "#/definitions/Plots"
@@ -442,7 +442,7 @@
       "properties": {
         "foreach": {
           "title": "Foreach",
-          "description": "Iterable to loop through in foreach. Can be a parametrized string, list or a dictionary.\n\nThe stages will be generated by iterating through this data, by substituting\ndata in the `do` block.",
+          "description": "Iterable to loop through in foreach. Can be a parametrized string, sequence or a mapping.\n\nThe stages will be generated by iterating through this data, by substituting\ndata in the `do` block.",
           "anyOf": [
             {
               "type": "string",