Skip to content

Commit c51b73d

Browse files
chore(eui): prepend link annotations with "See"
1 parent 7e5700a commit c51b73d

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

packages/eui/src/components/basic_table/basic_table.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ interface BasicTableProps<T extends object>
252252
noItemsMessage?: ReactNode;
253253
/**
254254
* Called whenever pagination or sorting changes (this property is required when either pagination or sorting is configured).
255-
* {@link Criteria} or {@link CriteriaWithPagination}
255+
* See {@link Criteria} or {@link CriteriaWithPagination}
256256
*/
257257
onChange?: (criteria: Criteria<T>) => void;
258258
/**

packages/eui/src/components/basic_table/in_memory_table.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,13 @@ type InMemoryTableProps<T extends object> = Omit<
107107
/**
108108
* `onChange` is not required when `pagination` and/or `sorting` are configured,
109109
* but if `onChange` is present it is responsible for handling state for each/both.
110-
* {@link Criteria} or {@link CriteriaWithPagination}
110+
* See {@link Criteria} or {@link CriteriaWithPagination}
111111
*/
112112
onChange?: EuiBasicTableProps<T>['onChange'];
113113
/**
114114
* Callback for when table pagination or sorting is changed. This is meant to be informational only,
115115
* and not used to set any state as the in-memory table already manages this state.
116-
* {@link Criteria} or {@link CriteriaWithPagination}.
116+
* See {@link Criteria} or {@link CriteriaWithPagination}.
117117
*/
118118
onTableChange?: (nextValues: Criteria<T>) => void;
119119
executeQueryOptions?: {

packages/eui/src/components/resizable_container/resizable_panel.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ export interface EuiResizablePanelControls {
8080
deregister: (panelId: EuiResizablePanelController['id']) => void;
8181
};
8282
/**
83-
* {@link ToggleCollapseCallback}
83+
* See {@link ToggleCollapseCallback}
8484
*/
8585
onToggleCollapsed?: ToggleCollapseCallback;
8686
onToggleCollapsedInternal: ToggleCollapseCallback;

packages/eui/src/components/search_bar/filters/field_value_selection_filter.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface FieldValueSelectionFilterConfigType {
4242
field?: string;
4343
name: string;
4444
/**
45-
* {@link FieldValueOptionType}
45+
* See {@link FieldValueOptionType}
4646
*/
4747
options: FieldValueOptionType[] | OptionsLoader;
4848
filterWith?: 'prefix' | 'includes' | OptionsFilter;

packages/eui/src/components/search_bar/filters/field_value_toggle_group_filter.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface FieldValueToggleGroupFilterConfigType {
2222
type: 'field_value_toggle_group';
2323
field: string;
2424
/**
25-
* {@link FieldValueToggleGroupFilterItemType}
25+
* See {@link FieldValueToggleGroupFilterItemType}
2626
*/
2727
items: FieldValueToggleGroupFilterItemType[];
2828
available?: () => boolean;

0 commit comments

Comments
 (0)