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

[Doc] Convert Avatar to use the new standard #2407

Merged
merged 1 commit into from Dec 8, 2015
Merged

[Doc] Convert Avatar to use the new standard #2407

merged 1 commit into from Dec 8, 2015

Conversation

oliviertassinari
Copy link
Member

This is following #2382.
We now have to convert every doc component. That's pretty straightforward.
This has several advantages:

  • Property description are no longer duplicated. That reduce the cost of maintaining them and the risk of inconsistency.
  • Property description are right into the source code. The improve the explicitness.
  • Examples code is no longer duplicated, with the same advantages as with the property description
  • Examples are explicit and almost completly decoupled from the doc source.
  • Those new examples are going to be great component to write unit test for
  • The writing of the doc is simplified by using the markdown abstraction over the jsx.
  • The code highlighting is far better.

@shaurya947
Copy link
Contributor

Looks good to me. So happy with where the docs are going ^_^

children: React.PropTypes.node,

/**
* The icon or letter color.
Copy link
Member

Choose a reason for hiding this comment

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

  • The icon or the letter's color.

@alitaheri
Copy link
Member

@oliviertassinari If you be so kind, let's address #2310 while we are migrating the docs. Add a className to Avatar while you're at it 😁. Like I did with #2415

/**
* The css class name of the root `div` element.
*/
className: React.PropTypes.string,
Copy link
Member

Choose a reason for hiding this comment

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

I don't mind this, but I think it helps readability to be more explicit. If you agree please add className to props destructuring and to the div's props.

@alitaheri
Copy link
Member

after that do a rebase and merge. 👍 👍 👍

oliviertassinari added a commit that referenced this pull request Dec 8, 2015
[Doc] Convert Avatar to use the new standard
@oliviertassinari oliviertassinari merged commit a5c89aa into mui:master Dec 8, 2015
@oliviertassinari oliviertassinari deleted the doc-codgen-avatar branch December 8, 2015 08:57
@alitaheri
Copy link
Member

🎉 👍

@zannager zannager added docs Improvements or additions to the documentation component: avatar This is the name of the generic UI component, not the React module! labels Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: avatar This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants