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

Slightly improve how the props table is generated. #2508

Merged

Conversation

alitaheri
Copy link
Member

@oliviertassinari This makes the enums even prettier. and also one more thing. Before this, each new line in the jsdoc (for code formatting) would result in a new line in the generated props, that made it ugly sometimes. With this, you can freely split jsdoc into any number of lines and still be able to make paragraphs by two consecutive new lines:

Before:

/**
 * This is
 * a new line
 */

=>
This is
a new line

Now:

/**
 * This is
 * not a new line
 *
 * This is a new paragraph.
 */

=>
This is not a new line
This is a new paragraph.

And with enums:

oneOf('foo','bar','baz');
// turns into:
enum:
 'foo'
 'bar'
 'baz'

What do you think?

@alitaheri alitaheri added the docs Improvements or additions to the documentation label Dec 13, 2015
@alitaheri alitaheri added this to the Improve the documentation milestone Dec 13, 2015
@oliviertassinari
Copy link
Member

@subjectix Well, I like it 👍

oliviertassinari added a commit that referenced this pull request Dec 13, 2015
Slightly improve how the props table is generated.
@oliviertassinari oliviertassinari merged commit 7493e75 into mui:master Dec 13, 2015
@alitaheri alitaheri deleted the improve-docs-codgen-prop-table branch December 13, 2015 23:23
@alitaheri
Copy link
Member Author

thanks 👍 🎉

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