Skip to content

chore(cleanup): prop comments using wrong notation #4216

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
redallen merged 1 commit into from
May 8, 2020
Merged

chore(cleanup): prop comments using wrong notation #4216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions packages/react-core/src/components/DataList/DataList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ import { css } from '@patternfly/react-styles';
import styles from '@patternfly/react-styles/css/components/DataList/data-list';

export interface DataListProps extends React.HTMLProps<HTMLUListElement> {
/* Content rendered inside the DataList list */
/** Content rendered inside the DataList list */
children?: React.ReactNode;
/* Additional classes added to the DataList list */
/** Additional classes added to the DataList list */
className?: string;
/* Adds accessible text to the DataList list */
/** Adds accessible text to the DataList list */
'aria-label': string;
/* Optional callback to make DataList selectable, fired when DataListItem selected */
/** Optional callback to make DataList selectable, fired when DataListItem selected */
onSelectDataListItem?: (id: string) => void;
/* Id of DataList item currently selected */
/** Id of DataList item currently selected */
selectedDataListItemId?: string;
/** Flag indicating if DataList should have compact styling */
isCompact?: boolean;
Expand Down
10 changes: 5 additions & 5 deletions packages/react-core/src/components/Drawer/DrawerPanelContent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ export interface DrawerPanelContentProps extends React.HTMLProps<HTMLDivElement>
className?: string;
/** Content to be rendered in the drawer panel. */
children?: React.ReactNode;
/* Flag indicating that the drawer panel should not have a border. */
/** Flag indicating that the drawer panel should not have a border. */
hasNoBorder?: boolean;
/* Default width for drawer panel */
/** Default width for drawer panel */
width?: 25 | 33 | 50 | 66 | 75 | 100;
/* Drawer panel width on large viewports */
/** Drawer panel width on large viewports */
widthOnLg?: 25 | 33 | 50 | 66 | 75 | 100;
/* Drawer panel width on xl viewports */
/** Drawer panel width on xl viewports */
widthOnXl?: 25 | 33 | 50 | 66 | 75 | 100;
/* Drawer panel width on 2xl viewports */
/** Drawer panel width on 2xl viewports */
widthOn2Xl?: 25 | 33 | 50 | 66 | 75 | 100;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/react-core/src/components/FileUpload/FileUpload.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export interface FileUploadProps
spinnerAriaValueText?: string;
/** Flag to show if the field is required. */
isRequired?: boolean;
/* Value to indicate if the field is modified to show that validation state.
/** Value to indicate if the field is modified to show that validation state.
* If set to success, field will be modified to indicate valid state.
* If set to error, field will be modified to indicate error state.
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/react-core/src/components/FileUpload/FileUploadField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export interface FileUploadFieldProps extends Omit<React.HTMLProps<HTMLDivElemen
spinnerAriaValueText?: string;
/** Flag to show if the field is required. */
isRequired?: boolean;
/* Value to indicate if the field is modified to show that validation state.
/** Value to indicate if the field is modified to show that validation state.
* If set to success, field will be modified to indicate valid state.
* If set to error, field will be modified to indicate error state.
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/react-core/src/components/FormSelect/FormSelect.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export interface FormSelectProps
className?: string;
/** value of selected option */
value?: any;
/* Value to indicate if the select is modified to show that validation state.
/** Value to indicate if the select is modified to show that validation state.
* If set to success, select will be modified to indicate valid state.
* If set to error, select will be modified to indicate error state.
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/react-core/src/components/TextInput/TextInput.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export interface TextInputProps extends Omit<React.HTMLProps<HTMLInputElement>,
isReadOnly?: boolean;
/** Flag to show if the input is required. */
isRequired?: boolean;
/* Value to indicate if the input is modified to show that validation state.
/** Value to indicate if the input is modified to show that validation state.
* If set to success, input will be modified to indicate valid state.
* If set to error, input will be modified to indicate error state.
*/
Expand Down