Docs: run the api-extractor on master to update docs (#23726)

* regenerated packages docs.

* fixed spelling issues.

* fixed spelling issues.
This commit is contained in:
Marcus Andersson
2020-04-21 10:41:50 +02:00
committed by GitHub
parent 017767ae39
commit a2d741f60f
275 changed files with 6448 additions and 2193 deletions

View File

@@ -18,7 +18,7 @@
"build": "grafana-toolkit package:build --scope=data",
"bundle": "rollup -c rollup.config.ts",
"clean": "rimraf ./dist ./compiled",
"docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
"docsExtract": "mkdir -p ../../reports/docs && api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
"lint": "eslint src/ --ext=.js,.ts,.tsx",
"typecheck": "tsc --noEmit"
},

View File

@@ -3,7 +3,7 @@ import { PanelPluginMeta } from './panel';
import { GrafanaTheme } from './theme';
/**
* Describes the build information that will be available via the Grafana cofiguration.
* Describes the build information that will be available via the Grafana configuration.
*
* @public
*/

View File

@@ -371,7 +371,7 @@ export interface DataQueryResponse {
}
/**
* These are the common properties avaliable to all queries in all datasources
* These are the common properties available to all queries in all datasources
* Specific implementations will extend this interface adding the required properties
* for the given context
*/

View File

@@ -86,7 +86,7 @@ export interface FieldConfigEditorConfig<TOptions, TSettings = any, TValue = any
*/
settings?: TSettings;
/**
* Funciton that allows specifying whether or not this field config shuld apply to a given field.
* Function that allows specifying whether or not this field config should apply to a given field.
* @param field
*/
shouldApply?: (field: Field) => boolean;

View File

@@ -23,7 +23,7 @@
"build": "grafana-toolkit package:build --scope=e2e",
"bundle": "rollup -c rollup.config.ts",
"clean": "rimraf ./dist ./compiled",
"docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
"docsExtract": "mkdir -p ../../reports/docs && api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
"lint": "eslint cypress/ src/ --ext=.js,.ts,.tsx",
"open": "cypress open",
"start": "cypress run",

View File

@@ -18,7 +18,7 @@
"build": "grafana-toolkit package:build --scope=runtime",
"bundle": "rollup -c rollup.config.ts",
"clean": "rimraf ./dist ./compiled",
"docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
"docsExtract": "mkdir -p ../../reports/docs && api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
"lint": "eslint src/ --ext=.js,.ts,.tsx",
"typecheck": "tsc --noEmit"
},

View File

@@ -1,6 +1,6 @@
/**
* Used to enable rendering of Angular components within a
* React component without loosing proper typings.
* React component without losing proper typings.
*
* @example
* ```typescript

View File

@@ -27,7 +27,7 @@ export interface EchoMeta {
*/
userLogin: string;
/**
* The current users uniqe identifier.
* The current users unique identifier.
*/
userId: number;
/**

View File

@@ -43,7 +43,7 @@ export type BackendSrvRequest = {
* a datasource etc. The BackendSrv is using the {@link https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API | Fetch API}
* under the hood to handle all the communication.
*
* The request function can be used to perform a remote call by specifing a {@link BackendSrvRequest}.
* The request function can be used to perform a remote call by specifying a {@link BackendSrvRequest}.
* To make the BackendSrv a bit easier to use we have added a couple of shorthand functions that will
* use default values executing the request.
*

View File

@@ -4,7 +4,7 @@ import { VariableModel } from '@grafana/data';
* Via the TemplateSrv consumers get access to all the available template variables
* that can be used within the current active dashboard.
*
* For a mor in-depth description visit: https://grafana.com/docs/grafana/latest/reference/templating
* For a more in-depth description visit: https://grafana.com/docs/grafana/latest/reference/templating
* @public
*/
export interface TemplateSrv {

View File

@@ -20,7 +20,7 @@
"build": "grafana-toolkit package:build --scope=ui",
"bundle": "rollup -c rollup.config.ts",
"clean": "rimraf ./dist ./compiled",
"docsExtract": "api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
"docsExtract": "mkdir -p ../../reports/docs && api-extractor run 2>&1 | tee ../../reports/docs/$(basename $(pwd)).log",
"lint": "eslint .storybook/ src/ --ext=.js,.ts,.tsx",
"storybook": "start-storybook -p 9001 -c .storybook -s .storybook/static",
"storybook:build": "build-storybook -o ./dist/storybook -c .storybook -s .storybook/static",

View File

@@ -77,7 +77,7 @@ export const getRowContexts = async (
if (idField) {
// For Loki this means we filter only the one row. Issue is we could have other rows logged at the same
// ns which came before but they come in the response that search for logs after. This means right now
// we will show those as if they came after. This is not strictly correct but seems better than loosing them
// we will show those as if they came after. This is not strictly correct but seems better than losing them
// and making this correct would mean quite a bit of complexity to shuffle things around and messing up
//counts.
if (idField.values.get(fieldIndex) === row.uid) {