Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.x] Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) #101087

Merged
merged 1 commit into from
Jun 1, 2021
Merged

[7.x] Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823) #101087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 79 additions & 19 deletions api_docs/bfetch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
"description": [],
"source": {
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 24
"lineNumber": 23
},
"deprecated": false,
"children": [
Expand All @@ -98,7 +98,7 @@
],
"source": {
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 25
"lineNumber": 24
},
"deprecated": false,
"returnComment": [],
Expand All @@ -115,7 +115,7 @@
],
"source": {
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 25
"lineNumber": 24
},
"deprecated": false
}
Expand Down Expand Up @@ -143,7 +143,7 @@
],
"source": {
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 26
"lineNumber": 25
},
"deprecated": false,
"returnComment": [],
Expand All @@ -161,7 +161,7 @@
],
"source": {
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 27
"lineNumber": 26
},
"deprecated": false
}
Expand Down Expand Up @@ -195,7 +195,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 39
"lineNumber": 41
},
"deprecated": false,
"children": [
Expand All @@ -211,7 +211,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 40
"lineNumber": 42
},
"deprecated": false,
"returnComment": [],
Expand All @@ -228,7 +228,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 40
"lineNumber": 42
},
"deprecated": false
}
Expand Down Expand Up @@ -290,7 +290,7 @@
"description": [],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 44
"lineNumber": 46
},
"deprecated": false,
"children": [
Expand Down Expand Up @@ -322,7 +322,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 45
"lineNumber": 47
},
"deprecated": false,
"returnComment": [],
Expand All @@ -336,7 +336,7 @@
"description": [],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 46
"lineNumber": 48
},
"deprecated": false
},
Expand Down Expand Up @@ -368,7 +368,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 47
"lineNumber": 49
},
"deprecated": false
}
Expand Down Expand Up @@ -402,7 +402,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 49
"lineNumber": 51
},
"deprecated": false,
"returnComment": [],
Expand All @@ -416,7 +416,7 @@
"description": [],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 50
"lineNumber": 52
},
"deprecated": false
},
Expand Down Expand Up @@ -448,7 +448,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 51
"lineNumber": 53
},
"deprecated": false
}
Expand Down Expand Up @@ -682,7 +682,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 81
"lineNumber": 83
},
"deprecated": false,
"returnComment": [],
Expand Down Expand Up @@ -719,7 +719,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 89
"lineNumber": 91
},
"deprecated": false
}
Expand All @@ -738,7 +738,7 @@
"description": [],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 94
"lineNumber": 96
},
"deprecated": false,
"children": [],
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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": []
}
}
3 changes: 3 additions & 0 deletions api_docs/bfetch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,6 @@ import bfetchObj from './bfetch.json';
### Interfaces
<DocDefinitionList data={bfetchObj.common.interfaces}/>

### Consts, variables and types
<DocDefinitionList data={bfetchObj.common.misc}/>

8 changes: 6 additions & 2 deletions api_docs/charts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,9 @@
"type": "Array",
"tags": [],
"label": "xValues",
"description": [],
"description": [
"sorted and unquie x values"
],
"signature": [
"number[]"
],
Expand Down Expand Up @@ -417,7 +419,9 @@
"type": "Object",
"tags": [],
"label": "splitSeriesAccessorFnMap",
"description": [],
"description": [
"needed when using `splitSeriesAccessors` as `AccessorFn`"
],
"signature": [
"Map<React.ReactText, ",
"AccessorFn",
Expand Down
Loading