Skip to content
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.

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

[Docs] Divider, DropDownMenu, FlatButton, FloatingActionButton, FontIcon - Add title & description to examples #2955

Merged
merged 5 commits into from
Jan 17, 2016

Conversation

mbrookes
Copy link
Member

For #2927.

@mbrookes mbrookes changed the title [Docs] Divider, DropDownMenu, FlatButton - Add title & description to examples [Docs] Divider, DropDownMenu, FlatButton, FontIcon - Add title & description to examples Jan 16, 2016
@mbrookes
Copy link
Member Author

Please check FontIcon in particular, as I wasn't totally sure of the reason the simple example only required a classname, while the other has the icon name as a child - or whether calling these Custom and Public was appropriate.

const descriptions = {
simple: '`FlatButton` with default color, `primary`, `secondary` and and `disabled` props applied.',
complex: 'The first example uses an `input` as a child component, ' +
'the next has next has an [SVG Icon](http://localhost:3000/#/components/svg-icon), with the label positioned after.' +
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should remove http://localhost:3000

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ach, sorry.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jan 16, 2016
@oliviertassinari
Copy link
Member

Please check FontIcon in particular, as I wasn't totally sure of the reason the simple example only required a classname, while the other has the icon name as a child - or whether calling these Custom and Public was appropriate.

That's a good point. Those classnames are declared outside of the examples, they are private to the documentation. I have seen many issues related to this.

@mbrookes mbrookes changed the title [Docs] Divider, DropDownMenu, FlatButton, FontIcon - Add title & description to examples [Docs] Divider, DropDownMenu, FlatButton, FloatingActionButton, FontIcon - Add title & description to examples Jan 16, 2016
simple: '`FlatButton` with default color, `primary`, `secondary` and and `disabled` props applied.',
complex: 'The first example uses an `input` as a child component, ' +
'the next has next has an [SVG Icon](/#/components/svg-icon), with the label positioned after. ' +
'The final example uses a [FontIcon](/#/components/font-icon, and is wrapped in an anchor tag.',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

font-icon**)**, and

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh my!

@mbrookes
Copy link
Member Author

Fixed up and squashed onto the FlatButton commit.

oliviertassinari added a commit that referenced this pull request Jan 17, 2016
[Docs] Divider, DropDownMenu,  FlatButton, FloatingActionButton, FontIcon - Add title & description to examples
@oliviertassinari oliviertassinari merged commit a99f624 into mui:master Jan 17, 2016
@oliviertassinari
Copy link
Member

@mbrookes Thanks

@mbrookes mbrookes deleted the docs-example-title-desc branch January 26, 2016 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants