Skip to content

Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. #100823

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

Merged
stacey-gammon merged 3 commits into from
May 28, 2021
Merged

Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. #100823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b4ed70
Make sure arrow functions capture parameter comments.
May 27, 2021
0fd5a25
Update docs
May 27, 2021
fc4fa5c
Merge branch 'master' of https://github.com/elastic/kibana into 2021-…
May 28, 2021
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
14 changes: 10 additions & 4 deletions api_docs/apm.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 270
"lineNumber": 269
},
"deprecated": false,
"children": [
Expand All @@ -331,7 +331,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 270
"lineNumber": 269
},
"deprecated": false,
"isRequired": true
Expand All @@ -351,7 +351,7 @@
],
"source": {
"path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 289
"lineNumber": 288
},
"deprecated": false,
"children": [],
Expand Down Expand Up @@ -653,7 +653,13 @@
"<unknown>>; delete: (deleteParams: { id: string; }) => Promise<",
"DeleteResponse",
">; } | undefined>; }; start: () => Promise<undefined>; }; ruleRegistry: { setup: ",
"RuleDataPluginService",
{
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleRegistryPluginSetupContract",
"text": "RuleRegistryPluginSetupContract"
},
"; start: () => Promise<void>; }; security?: { setup: ",
{
"pluginId": "security",
Expand Down
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
56 changes: 31 additions & 25 deletions api_docs/core.json
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 15 additions & 5 deletions api_docs/core_application.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,9 @@
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"description": [
"the URL path scope for the sub history"
],
"signature": [
"string"
],
Expand Down Expand Up @@ -207,7 +209,9 @@
"type": "CompoundType",
"tags": [],
"label": "pathOrLocation",
"description": [],
"description": [
"a string or location descriptor"
],
"signature": [
"string | ",
"LocationDescriptorObject",
Expand Down Expand Up @@ -266,7 +270,9 @@
"type": "CompoundType",
"tags": [],
"label": "pathOrLocation",
"description": [],
"description": [
"a string or location descriptor"
],
"signature": [
"string | ",
"LocationDescriptorObject",
Expand Down Expand Up @@ -323,7 +329,9 @@
"type": "number",
"tags": [],
"label": "n",
"description": [],
"description": [
"number of positions in the stack to go. Negative numbers indicate number of entries backward, positive\nnumbers for forwards. If passed 0, the current location will be reloaded. If `n` exceeds the number of\nentries available, this is a no-op."
],
"signature": [
"number"
],
Expand Down Expand Up @@ -449,7 +457,9 @@
"type": "Function",
"tags": [],
"label": "listener",
"description": [],
"description": [
"a function that receives location updates."
],
"signature": [
"(location: ",
"Location",
Expand Down
16 changes: 12 additions & 4 deletions api_docs/core_saved_objects.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,9 @@
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"description": [
"- [{ type, id, attributes, references, migrationVersion }]"
],
"signature": [
{
"pluginId": "core",
Expand Down Expand Up @@ -451,7 +453,9 @@
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"description": [
"- an array ids, or an array of objects containing id and optionally type"
],
"signature": [
"{ id: string; type: string; }[]"
],
Expand Down Expand Up @@ -9362,7 +9366,9 @@
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"description": [
"The namespace ID, which must be either a non-empty string or `undefined`."
],
"signature": [
"string | undefined"
],
Expand Down Expand Up @@ -9400,7 +9406,9 @@
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"description": [
"The namespace string, which must be non-empty."
],
"signature": [
"string"
],
Expand Down
Loading