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.

Sign up for GitHub

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

Jump to bottom

[docs] Improve generated markdown #16771

Merged
merged 4 commits into from
Jul 28, 2019
Merged

[docs] Improve generated markdown #16771

merged 4 commits into from
Jul 28, 2019

Conversation

merceyz
Copy link
Member

@merceyz merceyz commented Jul 26, 2019

Changes

  • Always place the vertical bar on the start of a new line
  • Don't show enum/union text
  • Separate types using vertical bar only
  • Support arrayOf

Remarks

  • Array doesn't look good when the type isn't a primitive, suggestions welcome.

Before/after
https://material-ui.com/api/hidden/#hidden-api
image
image

@mui-pr-bot
Copy link

No bundle size changes comparing bff38c1...3585d9c

Generated by 🚫 dangerJS against 3585d9c

@eps1lon eps1lon self-requested a review July 27, 2019 06:45
@eps1lon eps1lon added the docs Improvements or additions to the documentation label Jul 27, 2019
eps1lon
eps1lon reviewed Jul 27, 2019
View reviewed changes
Copy link
Member

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

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

Don't show enum/union text

👍

Support arrayOf

Where do we use this?

@merceyz
Copy link
Member Author

merceyz commented Jul 27, 2019

Where do we use this?

3585d9c
https://material-ui.com/api/hidden/#props
https://material-ui.com/api/slider/#props

@oliviertassinari oliviertassinari merged commit e26e3b4 into mui:master Jul 28, 2019
@oliviertassinari
Copy link
Member

@merceyz I love how it yields more space for the description of the prop, really nice :)

@merceyz merceyz deleted the docs-md branch July 28, 2019 10:08
@snyk-bot snyk-bot mentioned this pull request Sep 4, 2019
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eps1lon eps1lon eps1lon left review comments

@oliviertassinari oliviertassinari oliviertassinari approved these changes

@joshwooding joshwooding joshwooding approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@merceyz @mui-pr-bot @oliviertassinari @eps1lon @joshwooding