Docs: added code comments to frontend packages. (#28784)

* fixed docs linting errors.

* decreased the limit.
pull/28765/head
Marcus Andersson 5 years ago committed by GitHub
parent 8954130f1a
commit 212bf7a4f6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 8
      packages/grafana-data/src/types/data.ts
  2. 2
      scripts/ci-reference-docs-lint.sh

@ -6,6 +6,7 @@ export type KeyValue<T = any> = Record<string, T>;
/**
* Represent panel data loading state.
* @public
*/
export enum LoadingState {
NotStarted = 'NotStarted',
@ -21,6 +22,9 @@ export enum DataTopic {
export type PreferredVisualisationType = 'graph' | 'table' | 'logs' | 'trace';
/**
* @public
*/
export interface QueryResultMeta {
/** DatasSource Specific Values */
custom?: Record<string, any>;
@ -67,6 +71,7 @@ export interface QueryResultMetaStat extends FieldConfig {
/**
* QueryResultMetaNotice is a structure that provides user notices for query result data
* @public
*/
export interface QueryResultMetaNotice {
/**
@ -91,6 +96,9 @@ export interface QueryResultMetaNotice {
inspect?: 'meta' | 'error' | 'data' | 'stats';
}
/**
* @public
*/
export interface QueryResultBase {
/**
* Matches the query target refId

@ -29,7 +29,7 @@ if [ ! -d "$REPORT_PATH" ]; then
fi
WARNINGS_COUNT="$(find "$REPORT_PATH" -type f -name \*.log -print0 | xargs -0 grep -o "Warning: " | wc -l | xargs)"
WARNINGS_COUNT_LIMIT=1077
WARNINGS_COUNT_LIMIT=1075
if [ "$WARNINGS_COUNT" -gt $WARNINGS_COUNT_LIMIT ]; then
echo -e "API Extractor warnings/errors $WARNINGS_COUNT exceeded $WARNINGS_COUNT_LIMIT so failing build.\n"

Loading…
Cancel
Save