-
-
Notifications
You must be signed in to change notification settings - Fork 32.2k
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
[MenuItem][Table][Tabs] Hide internal properties in docs #3589
Conversation
d0f61ea
to
8296afb
Compare
@heetvachhani - please don't squash until we're ready to merge, it makes it hard to see what's changed. |
okay sure will take care of it next time 😁 |
@@ -82,11 +83,13 @@ const MenuItem = React.createClass({ | |||
|
|||
/** | |||
* Override the inline-styles of the root element. | |||
* @ignore | |||
*/ | |||
style: React.PropTypes.object, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why?
I hope so! Please squash. |
a71c669
to
211fa95
Compare
@callemall/material-ui - please take a look and merge if you're happy. |
Some tags are before the description and some are after. Please be consistent. Guys do you think it should be after or before? I'm not sure myself O.o |
Good catch, I spotted this and meant to come back to it after we were done chasing and tracing to figure out which ones to @ignore. I just had a look at what's been done previously, and most of the existing ones are before, but some are after, so there is no consistency. Also It would be good to be consistent, but I don't mind which. Before is perhaps a little more explicit. |
Yeah might not be a bad idea to keep after only for function signature. so signature and |
Better have a PR making all consistent afterward 👍 |
@newoga @oliviertassinari Any objections? If none merge, thanks 👍 👍 |
Can we get a custom eslint rule for that? 😄 |
2640aa7
to
2b8cf8b
Compare
@heetvachhani Can you squash this? Thanks! |
Added @ignore tag to hide public child component from documentation
2b8cf8b
to
dbd6805
Compare
Done @newoga ! |
@heetvachhani Good work 👍. |
Thanks @heetvachhani 👍 👍 |
[MenuItem][Table][Tabs] Hide internal properties in docs
@heetvachhani I think you overdid the For The same applies to all Why is |
tests/ docs demo, and is linted.A number of props that are controlled by a parent component are visible in the docs. This PR hides them.
Some of the table click / hover in particular cause confusion, as they appear to offer functionality that doesn't exist. While this should be fixed at some point (parent component should attach to a separate internal use callback prop), for now hiding them will reduce confusion.
The associated issue lists all the components that have been checked.
Closes #3588.