Ensure comments on parameters in arrow functions are captured in the …

…docs and ci metrics. (elastic#100823) * Make sure arrow functions capture parameter comments. * Update docs # Conflicts: # api_docs/apm.json # api_docs/core.json # api_docs/data.json # api_docs/data_index_patterns.json # api_docs/data_search.json # api_docs/licensing.json # api_docs/reporting.json # api_docs/spaces.json
stacey-gammon · Jun 1, 2021 · 52717fe · 52717fe
1 parent 313a887
commit 52717fe
Show file tree

Hide file tree

Showing 24 changed files with 491 additions and 225 deletions.
diff --git a/api_docs/bfetch.json b/api_docs/bfetch.json
@@ -78,7 +78,7 @@
       "description": [],
       "source": {
         "path": "src/plugins/bfetch/public/plugin.ts",
-        "lineNumber": 24
+        "lineNumber": 23
       },
       "deprecated": false,
       "children": [
@@ -98,7 +98,7 @@
           ],
           "source": {
             "path": "src/plugins/bfetch/public/plugin.ts",
-            "lineNumber": 25
+            "lineNumber": 24
           },
           "deprecated": false,
           "returnComment": [],
@@ -115,7 +115,7 @@
               ],
               "source": {
                 "path": "src/plugins/bfetch/public/plugin.ts",
-                "lineNumber": 25
+                "lineNumber": 24
               },
               "deprecated": false
             }
@@ -143,7 +143,7 @@
           ],
           "source": {
             "path": "src/plugins/bfetch/public/plugin.ts",
-            "lineNumber": 26
+            "lineNumber": 25
           },
           "deprecated": false,
           "returnComment": [],
@@ -161,7 +161,7 @@
               ],
               "source": {
                 "path": "src/plugins/bfetch/public/plugin.ts",
-                "lineNumber": 27
+                "lineNumber": 26
               },
               "deprecated": false
             }
@@ -195,7 +195,7 @@
         ],
         "source": {
           "path": "src/plugins/bfetch/server/plugin.ts",
-          "lineNumber": 39
+          "lineNumber": 41
         },
         "deprecated": false,
         "children": [
@@ -211,7 +211,7 @@
             ],
             "source": {
               "path": "src/plugins/bfetch/server/plugin.ts",
-              "lineNumber": 40
+              "lineNumber": 42
             },
             "deprecated": false,
             "returnComment": [],
@@ -228,7 +228,7 @@
                 ],
                 "source": {
                   "path": "src/plugins/bfetch/server/plugin.ts",
-                  "lineNumber": 40
+                  "lineNumber": 42
                 },
                 "deprecated": false
               }
@@ -290,7 +290,7 @@
       "description": [],
       "source": {
         "path": "src/plugins/bfetch/server/plugin.ts",
-        "lineNumber": 44
+        "lineNumber": 46
       },
       "deprecated": false,
       "children": [
@@ -322,7 +322,7 @@
           ],
           "source": {
             "path": "src/plugins/bfetch/server/plugin.ts",
-            "lineNumber": 45
+            "lineNumber": 47
           },
           "deprecated": false,
           "returnComment": [],
@@ -336,7 +336,7 @@
               "description": [],
               "source": {
                 "path": "src/plugins/bfetch/server/plugin.ts",
-                "lineNumber": 46
+                "lineNumber": 48
               },
               "deprecated": false
             },
@@ -368,7 +368,7 @@
               ],
               "source": {
                 "path": "src/plugins/bfetch/server/plugin.ts",
-                "lineNumber": 47
+                "lineNumber": 49
               },
               "deprecated": false
             }
@@ -402,7 +402,7 @@
           ],
           "source": {
             "path": "src/plugins/bfetch/server/plugin.ts",
-            "lineNumber": 49
+            "lineNumber": 51
           },
           "deprecated": false,
           "returnComment": [],
@@ -416,7 +416,7 @@
               "description": [],
               "source": {
                 "path": "src/plugins/bfetch/server/plugin.ts",
-                "lineNumber": 50
+                "lineNumber": 52
               },
               "deprecated": false
             },
@@ -448,7 +448,7 @@
               ],
               "source": {
                 "path": "src/plugins/bfetch/server/plugin.ts",
-                "lineNumber": 51
+                "lineNumber": 53
               },
               "deprecated": false
             }
@@ -682,7 +682,7 @@
           ],
           "source": {
             "path": "src/plugins/bfetch/server/plugin.ts",
-            "lineNumber": 81
+            "lineNumber": 83
           },
           "deprecated": false,
           "returnComment": [],
@@ -719,7 +719,7 @@
               ],
               "source": {
                 "path": "src/plugins/bfetch/server/plugin.ts",
-                "lineNumber": 89
+                "lineNumber": 91
               },
               "deprecated": false
             }
@@ -738,7 +738,7 @@
       "description": [],
       "source": {
         "path": "src/plugins/bfetch/server/plugin.ts",
-        "lineNumber": 94
+        "lineNumber": 96
       },
       "deprecated": false,
       "children": [],
@@ -1343,6 +1343,48 @@
         ],
         "initialIsOpen": false
       },
+      {
+        "parentPluginId": "bfetch",
+        "id": "def-common.BatchItemWrapper",
+        "type": "Interface",
+        "tags": [],
+        "label": "BatchItemWrapper",
+        "description": [],
+        "source": {
+          "path": "src/plugins/bfetch/common/batch.ts",
+          "lineNumber": 23
+        },
+        "deprecated": false,
+        "children": [
+          {
+            "parentPluginId": "bfetch",
+            "id": "def-common.BatchItemWrapper.compressed",
+            "type": "boolean",
+            "tags": [],
+            "label": "compressed",
+            "description": [],
+            "source": {
+              "path": "src/plugins/bfetch/common/batch.ts",
+              "lineNumber": 24
+            },
+            "deprecated": false
+          },
+          {
+            "parentPluginId": "bfetch",
+            "id": "def-common.BatchItemWrapper.payload",
+            "type": "string",
+            "tags": [],
+            "label": "payload",
+            "description": [],
+            "source": {
+              "path": "src/plugins/bfetch/common/batch.ts",
+              "lineNumber": 25
+            },
+            "deprecated": false
+          }
+        ],
+        "initialIsOpen": false
+      },
       {
         "parentPluginId": "bfetch",
         "id": "def-common.BatchRequestData",
@@ -1684,7 +1726,25 @@
       }
     ],
     "enums": [],
-    "misc": [],
+    "misc": [
+      {
+        "parentPluginId": "bfetch",
+        "id": "def-common.DISABLE_BFETCH_COMPRESSION",
+        "type": "string",
+        "tags": [],
+        "label": "DISABLE_BFETCH_COMPRESSION",
+        "description": [],
+        "signature": [
+          "\"bfetch:disableCompression\""
+        ],
+        "source": {
+          "path": "src/plugins/bfetch/common/constants.ts",
+          "lineNumber": 9
+        },
+        "deprecated": false,
+        "initialIsOpen": false
+      }
+    ],
     "objects": []
   }
 }
diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx
@@ -47,3 +47,6 @@ import bfetchObj from './bfetch.json';
 ### Interfaces
 <DocDefinitionList data={bfetchObj.common.interfaces}/>
 
+### Consts, variables and types
+<DocDefinitionList data={bfetchObj.common.misc}/>
+
diff --git a/api_docs/charts.json b/api_docs/charts.json
@@ -179,7 +179,9 @@
             "type": "Array",
             "tags": [],
             "label": "xValues",
-            "description": [],
+            "description": [
+              "sorted and unquie x values"
+            ],
             "signature": [
               "number[]"
             ],
@@ -417,7 +419,9 @@
             "type": "Object",
             "tags": [],
             "label": "splitSeriesAccessorFnMap",
-            "description": [],
+            "description": [
+              "needed when using `splitSeriesAccessors` as `AccessorFn`"
+            ],
             "signature": [
               "Map<React.ReactText, ",
               "AccessorFn",