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] Hide internal props from documentation #3588

Closed
21 tasks done
heetvachhani opened this issue Mar 3, 2016 · 4 comments
Closed
21 tasks done

[Docs] Hide internal props from documentation #3588

heetvachhani opened this issue Mar 3, 2016 · 4 comments
Assignees
Labels
docs Improvements or additions to the documentation umbrella For grouping multiple issues to provide a holistic view

Comments

@heetvachhani
Copy link
Contributor

@mbrookes suggested to make a list of components that have public child component so that I can hide props by adding @ignore tag to them and close this issue properly.

Here's the list:

Feel free to add more if I forgot something 😅

Reference #3191

heetvachhani added a commit to heetvachhani/material-ui that referenced this issue Mar 3, 2016
Added @ignore tag to hide public child component from documentation
closes mui#3588
@alitaheri alitaheri added docs Improvements or additions to the documentation umbrella For grouping multiple issues to provide a holistic view labels Mar 4, 2016
@mbrookes
Copy link
Member

mbrookes commented Mar 4, 2016

Just looking at TextField again - those aren't publicly documented subcomponents, so @ignore has no purpose, but no harm done.

@mbrookes
Copy link
Member

mbrookes commented Mar 4, 2016

I've updated the list to cover all the components with public sub-components. I've reviewed Table, and added some props I think should be hidded (given the current implementation). Please check the carefully before @ignoreing! 😅

I've have double-checked RadioButton & Tabs - they look fine.

I will let you inspect the rest. 👍

@heetvachhani
Copy link
Contributor Author

Thanks @mbrookes for updating the list 👍

@mbrookes
Copy link
Member

mbrookes commented Mar 4, 2016

Card docs say:

actAsExpander bool false Whether a click on this card component expands the card. Can be set on any child of the Card component.

Please reinstate it anywhere it's @ignored

Same for expandable and showExpandableButton.
.

@mbrookes mbrookes self-assigned this Mar 4, 2016
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 umbrella For grouping multiple issues to provide a holistic view
Projects
None yet
Development

No branches or pull requests

3 participants