Skip to content

Commit

Permalink
[docs] Better API wording
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari committed Jun 25, 2018
1 parent 470c3e5 commit 069ca1f
Show file tree
Hide file tree
Showing 104 changed files with 104 additions and 104 deletions.
2 changes: 1 addition & 1 deletion docs/src/modules/utils/generateMarkdown.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ function generateHeader(reactAPI) {
return [
'---',
`filename: ${normalizePath(reactAPI.filename)}`,
`title: API of ${reactAPI.name}`,
`title: ${reactAPI.name} API`,
'---',
].join('\n');
}
Expand Down
2 changes: 1 addition & 1 deletion pages/api/app-bar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/AppBar/AppBar.js
title: API of AppBar
title: AppBar API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/avatar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Avatar/Avatar.js
title: API of Avatar
title: Avatar API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/backdrop.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Backdrop/Backdrop.js
title: API of Backdrop
title: Backdrop API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/badge.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Badge/Badge.js
title: API of Badge
title: Badge API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/bottom-navigation-action.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/BottomNavigationAction/BottomNavigationAction.js
title: API of BottomNavigationAction
title: BottomNavigationAction API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/bottom-navigation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/BottomNavigation/BottomNavigation.js
title: API of BottomNavigation
title: BottomNavigation API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/button-base.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/ButtonBase/ButtonBase.js
title: API of ButtonBase
title: ButtonBase API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/button.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Button/Button.js
title: API of Button
title: Button API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/card-actions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/CardActions/CardActions.js
title: API of CardActions
title: CardActions API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/card-content.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/CardContent/CardContent.js
title: API of CardContent
title: CardContent API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/card-header.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/CardHeader/CardHeader.js
title: API of CardHeader
title: CardHeader API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/card-media.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/CardMedia/CardMedia.js
title: API of CardMedia
title: CardMedia API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/card.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Card/Card.js
title: API of Card
title: Card API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/checkbox.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Checkbox/Checkbox.js
title: API of Checkbox
title: Checkbox API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/chip.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Chip/Chip.js
title: API of Chip
title: Chip API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/circular-progress.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/CircularProgress/CircularProgress.js
title: API of CircularProgress
title: CircularProgress API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/click-away-listener.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/ClickAwayListener/ClickAwayListener.js
title: API of ClickAwayListener
title: ClickAwayListener API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/collapse.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Collapse/Collapse.js
title: API of Collapse
title: Collapse API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/css-baseline.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/CssBaseline/CssBaseline.js
title: API of CssBaseline
title: CssBaseline API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/dialog-actions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/DialogActions/DialogActions.js
title: API of DialogActions
title: DialogActions API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/dialog-content-text.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/DialogContentText/DialogContentText.js
title: API of DialogContentText
title: DialogContentText API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/dialog-content.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/DialogContent/DialogContent.js
title: API of DialogContent
title: DialogContent API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/dialog-title.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/DialogTitle/DialogTitle.js
title: API of DialogTitle
title: DialogTitle API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/dialog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Dialog/Dialog.js
title: API of Dialog
title: Dialog API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/divider.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Divider/Divider.js
title: API of Divider
title: Divider API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/drawer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Drawer/Drawer.js
title: API of Drawer
title: Drawer API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/expansion-panel-actions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/ExpansionPanelActions/ExpansionPanelActions.js
title: API of ExpansionPanelActions
title: ExpansionPanelActions API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/expansion-panel-details.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/ExpansionPanelDetails/ExpansionPanelDetails.js
title: API of ExpansionPanelDetails
title: ExpansionPanelDetails API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/expansion-panel-summary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/ExpansionPanelSummary/ExpansionPanelSummary.js
title: API of ExpansionPanelSummary
title: ExpansionPanelSummary API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/expansion-panel.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/ExpansionPanel/ExpansionPanel.js
title: API of ExpansionPanel
title: ExpansionPanel API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/fade.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Fade/Fade.js
title: API of Fade
title: Fade API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/form-control-label.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/FormControlLabel/FormControlLabel.js
title: API of FormControlLabel
title: FormControlLabel API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/form-control.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/FormControl/FormControl.js
title: API of FormControl
title: FormControl API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/form-group.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/FormGroup/FormGroup.js
title: API of FormGroup
title: FormGroup API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/form-helper-text.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/FormHelperText/FormHelperText.js
title: API of FormHelperText
title: FormHelperText API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/form-label.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/FormLabel/FormLabel.js
title: API of FormLabel
title: FormLabel API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/grid-list-tile-bar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/GridListTileBar/GridListTileBar.js
title: API of GridListTileBar
title: GridListTileBar API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/grid-list-tile.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/GridListTile/GridListTile.js
title: API of GridListTile
title: GridListTile API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/grid-list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/GridList/GridList.js
title: API of GridList
title: GridList API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/grid.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Grid/Grid.js
title: API of Grid
title: Grid API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/grow.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Grow/Grow.js
title: API of Grow
title: Grow API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/hidden.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Hidden/Hidden.js
title: API of Hidden
title: Hidden API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/icon-button.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/IconButton/IconButton.js
title: API of IconButton
title: IconButton API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/icon.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Icon/Icon.js
title: API of Icon
title: Icon API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/input-adornment.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/InputAdornment/InputAdornment.js
title: API of InputAdornment
title: InputAdornment API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/input-label.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/InputLabel/InputLabel.js
title: API of InputLabel
title: InputLabel API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/input.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/Input/Input.js
title: API of Input
title: Input API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
2 changes: 1 addition & 1 deletion pages/api/linear-progress.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
filename: /packages/material-ui/src/LinearProgress/LinearProgress.js
title: API of LinearProgress
title: LinearProgress API
---

<!--- This documentation is automatically generated, do not try to edit it. -->
Expand Down
Loading

0 comments on commit 069ca1f

Please sign in to comment.