Commit 212bf7a4 by Marcus Andersson Committed by GitHub

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

* fixed docs linting errors.

* decreased the limit.
parent 8954130f
...@@ -6,6 +6,7 @@ export type KeyValue<T = any> = Record<string, T>; ...@@ -6,6 +6,7 @@ export type KeyValue<T = any> = Record<string, T>;
/** /**
* Represent panel data loading state. * Represent panel data loading state.
* @public
*/ */
export enum LoadingState { export enum LoadingState {
NotStarted = 'NotStarted', NotStarted = 'NotStarted',
...@@ -21,6 +22,9 @@ export enum DataTopic { ...@@ -21,6 +22,9 @@ export enum DataTopic {
export type PreferredVisualisationType = 'graph' | 'table' | 'logs' | 'trace'; export type PreferredVisualisationType = 'graph' | 'table' | 'logs' | 'trace';
/**
* @public
*/
export interface QueryResultMeta { export interface QueryResultMeta {
/** DatasSource Specific Values */ /** DatasSource Specific Values */
custom?: Record<string, any>; custom?: Record<string, any>;
...@@ -67,6 +71,7 @@ export interface QueryResultMetaStat extends FieldConfig { ...@@ -67,6 +71,7 @@ export interface QueryResultMetaStat extends FieldConfig {
/** /**
* QueryResultMetaNotice is a structure that provides user notices for query result data * QueryResultMetaNotice is a structure that provides user notices for query result data
* @public
*/ */
export interface QueryResultMetaNotice { export interface QueryResultMetaNotice {
/** /**
...@@ -91,6 +96,9 @@ export interface QueryResultMetaNotice { ...@@ -91,6 +96,9 @@ export interface QueryResultMetaNotice {
inspect?: 'meta' | 'error' | 'data' | 'stats'; inspect?: 'meta' | 'error' | 'data' | 'stats';
} }
/**
* @public
*/
export interface QueryResultBase { export interface QueryResultBase {
/** /**
* Matches the query target refId * Matches the query target refId
......
...@@ -29,7 +29,7 @@ if [ ! -d "$REPORT_PATH" ]; then ...@@ -29,7 +29,7 @@ if [ ! -d "$REPORT_PATH" ]; then
fi fi
WARNINGS_COUNT="$(find "$REPORT_PATH" -type f -name \*.log -print0 | xargs -0 grep -o "Warning: " | wc -l | xargs)" 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 if [ "$WARNINGS_COUNT" -gt $WARNINGS_COUNT_LIMIT ]; then
echo -e "API Extractor warnings/errors $WARNINGS_COUNT exceeded $WARNINGS_COUNT_LIMIT so failing build.\n" echo -e "API Extractor warnings/errors $WARNINGS_COUNT exceeded $WARNINGS_COUNT_LIMIT so failing build.\n"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment