Skip to content

Commit

Permalink
readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
pkuliga committed May 15, 2024
1 parent d394b17 commit aee0c95
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion client/blocks/site/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This component displays a Site item using site data retrieved from Redux store.
import Site from 'calypso/blocks/site';

function render() {
return <Site siteId={ siteId } indicator={ true } />;
return <Site siteId={ siteId } indicator />;
}
```

Expand Down
2 changes: 1 addition & 1 deletion client/blocks/term-form-dialog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The `TermFormDialog` component renders a dialog that allows to create/edit Terms
```jsx
import TermFormDialog from 'calypso/blocks/term-form-dialog';

<TermFormDialog showDialog={ true } taxonomy="category" onClose={ callback } postType="post" />;
<TermFormDialog showDialog taxonomy="category" onClose={ callback } postType="post" />;
```

## Props
Expand Down
2 changes: 1 addition & 1 deletion client/blocks/upsell-nudge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function myUpsell() {
callToAction={ translate( 'Upgrade' ) }
title={ translate( 'Free domain with a plan!' ) }
href="/plans"
showIcon={ true }
showIcon
compact
/>
);
Expand Down
2 changes: 1 addition & 1 deletion client/components/action-card/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ function render() {
className={ classnames( 'my-classname-1', 'my-classname-2' ) }
buttonText="Call to action!"
buttonIcon="external"
buttonPrimary={ true }
buttonPrimary
buttonHref="https://wordpress.com"
buttonTarget="_blank"
buttonOnClick={ noop }
Expand Down
4 changes: 2 additions & 2 deletions client/components/action-panel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const ActionPanelExample = ( { translate } ) => {
<div>
<ActionPanel>
<ActionPanelBody>
<ActionPanelFigure inlineBodyText={ true }>
<ActionPanelFigure inlineBodyText>
<img
src="/calypso/images/wordpress/logo-stars.svg"
width="170"
Expand All @@ -40,7 +40,7 @@ const ActionPanelExample = ( { translate } ) => {
</ActionPanel>
<ActionPanel>
<ActionPanelBody>
<ActionPanelFigure inlineBodyText={ true } align="left">
<ActionPanelFigure inlineBodyText align="left">
<img
src="/calypso/images/wordpress/logo-stars.svg"
width="170"
Expand Down
2 changes: 1 addition & 1 deletion client/components/breadcrumb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const BreadcrumbExamples = () => {
<br />
<Breadcrumb items={ navigationItems } />
<br />
<Breadcrumb items={ navigationItems } mobileItem="Go Back" compact={ true } />
<Breadcrumb items={ navigationItems } mobileItem="Go Back" compact />
</>
);
};
Expand Down
2 changes: 1 addition & 1 deletion client/components/jetpack/threat-dialog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default function MyComponent() {
threatDescription="Description..."
action="fix"
siteName="WordPress.com"
showDialog={ true }
showDialog
onCloseDialog={ () => console.log( 'Closing this dialog...' ) }
onConfirmation={ () => console.log( 'Fixing this threat...' ) }
/>
Expand Down
2 changes: 1 addition & 1 deletion client/components/redirect-when-logged-in/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class YourComponent extends React.Component {
<RedirectWhenLoggedIn
delayAtMount={ 3500 }
redirectTo="/"
replaceCurrentLocation={ true }
replaceCurrentLocation
waitForEmailAddress={ this.props.emailAddress }
/>
Stuff you want logged-out users to see before they log in.
Expand Down
2 changes: 1 addition & 1 deletion client/layout/sidebar-v2/navigator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ A component representing an individual menu item.
link="/item-link"
title="Menu Item 1"
onClickMenuItem={ handleClick }
isSelected={ true }
isSelected
/>
</SidebarNavigatorMenu>
</SidebarNavigator>
Expand Down
12 changes: 6 additions & 6 deletions client/my-sites/plan-compare-card/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ This component is used to display a current or next plan, highlighting the featu
## Usage

```javascript
<PlanCompareCard title="Free Plan" line="Free for life" buttonName="Your Plan" currentPlan={ true }>
<PlanCompareCardItem highlight={ true }>3GB Space</PlanCompareCardItem>
<PlanCompareCardItem unavailable={ true }>Custom Domain</PlanCompareCardItem>
<PlanCompareCardItem unavailable={ true }>No Ads</PlanCompareCardItem>
<PlanCompareCardItem unavailable={ true }>Custom Design</PlanCompareCardItem>
<PlanCompareCardItem unavailable={ true }>VideoPress</PlanCompareCardItem>
<PlanCompareCard title="Free Plan" line="Free for life" buttonName="Your Plan" currentPlan>
<PlanCompareCardItem highlight>3GB Space</PlanCompareCardItem>
<PlanCompareCardItem unavailable>Custom Domain</PlanCompareCardItem>
<PlanCompareCardItem unavailable>No Ads</PlanCompareCardItem>
<PlanCompareCardItem unavailable>Custom Design</PlanCompareCardItem>
<PlanCompareCardItem unavailable>VideoPress</PlanCompareCardItem>
</PlanCompareCard>;
```

Expand Down
2 changes: 1 addition & 1 deletion client/my-sites/plugins/plugin-autoupdate-toggle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import PluginAutoupdateToggle from 'calypso/my-sites/plugins/plugin-autoupdate-t
function render() {
return (
<div className="your-plugins-list">
<PluginAutoupdateToggle plugin={ plugin } site={ site } notices={ notices } wporg={ true } />
<PluginAutoupdateToggle plugin={ plugin } site={ site } notices={ notices } wporg />
</div>
);
}
Expand Down
2 changes: 1 addition & 1 deletion client/my-sites/store/components/table/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ function render() {
[ 7, 8, 9 ],
];
return (
<Table header={ titles } compact={ true }>
<Table header={ titles } compact>
{ values.map( ( row, i ) => (
<TableRow key={ i }>
{ row.map( ( item, j ) => (
Expand Down

0 comments on commit aee0c95

Please sign in to comment.