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

Conditionally include the Description column for the PropsTable component #385

Merged
merged 5 commits into from
Oct 27, 2018

Conversation

Jared-Dev
Copy link
Contributor

@Jared-Dev Jared-Dev commented Oct 2, 2018

Description

When generating docs for an internal project with the window made narrow. I was running out of space for the PropsTable component when no descriptions were present for that component. It didn't appear that there was a flag available for this and after thinking about it I decided this wasn't necessary since it could be inferred if this should be included.

Review

  • Code Review

Screenshots

Before After
image image
Before even if a Description was never used the column displayed Now if none of the Props provide a description comment the column is removed

This was tested and appears to be functional based on all the checks specified in the contributing guide.

Jared Malcolm added 2 commits October 2, 2018 17:43
* Adds a description to the Alert component in the
basic examples to demonstrate it being added
* The Button component in the basic example has no
descriptions to demonstrate it being excluded
Jared-Dev and others added 2 commits October 27, 2018 10:53
* Updates the PropsTable to render '[Empty String]' instead of nothing.
* Add the code to print [No Default]
@pedronauck pedronauck changed the base branch from master to dev October 27, 2018 14:14
@pedronauck pedronauck merged commit 829a3aa into doczjs:dev Oct 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants