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 properties from docs #2973

Closed
mbrookes opened this issue Jan 18, 2016 · 12 comments
Closed

[Docs] Hide internal properties from docs #2973

mbrookes opened this issue Jan 18, 2016 · 12 comments
Labels
docs Improvements or additions to the documentation

Comments

@mbrookes
Copy link
Member

For example the checked property of RadioButton is only used by RadioButtonGroup, but is shown in the public documentation Properties table.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jan 18, 2016
@mbrookes mbrookes changed the title [Docs] Option to hide internal properties from docs [Docs] Hide internal properties from docs Jan 18, 2016
@alitaheri
Copy link
Member

@mbrookes @oliviertassinari How about an @internal tag? Doctrine can pick it up and we can exclude it from the table. Thoughts?

@newoga
Copy link
Contributor

newoga commented Jan 19, 2016

That makes sense to me. 👍

@alitaheri
Copy link
Member

@newoga the internal tag or the idea of internal properties? 😁

@newoga
Copy link
Contributor

newoga commented Jan 19, 2016

Both! 😄

@alitaheri
Copy link
Member

Thanks 😅 😅 😅

@oliviertassinari
Copy link
Member

@mbrookes Can we close this issue?

@mbrookes
Copy link
Member Author

@heetvachhani - in #3247 did you trace through each component to see which subcomponent props (for public, documented subcomponents) are controlled by the parent, or just add muiTheme and the couple I had already commented?

@heetvachhani
Copy link
Contributor

@mbrookes I went through most of the component but it seems that all of the props needed in the documentation page. so haven't removed that. I will still look for internal props in case if I missed some and will remove that. Thanks! 😁

@mbrookes
Copy link
Member Author

@heetvachhani - no, if you already did this we're good. I just wanted to double check with you before closing. 👍

@mbrookes
Copy link
Member Author

mbrookes commented Mar 3, 2016

@heetvachhani - just looking at a Tabs issue, and I notice Tab has a number of props that are controlled by Tabs. Could you take a look and @ignore them? Thanks! 👍

@heetvachhani
Copy link
Contributor

Yeah sure will @ignore that @mbrookes

@mbrookes
Copy link
Member Author

mbrookes commented Mar 4, 2016

Closed in favour of #3588.

@mbrookes mbrookes closed this as completed 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
Projects
None yet
Development

No branches or pull requests

5 participants