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] [TableCell] Inconsistency regarding padding and size properties #16369

Closed
2 tasks done
the-question opened this issue Jun 25, 2019 · 3 comments · Fixed by #16378
Closed
2 tasks done

[docs] [TableCell] Inconsistency regarding padding and size properties #16369

the-question opened this issue Jun 25, 2019 · 3 comments · Fixed by #16378
Labels
docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process.

Comments

@the-question
Copy link
Contributor

the-question commented Jun 25, 2019

  • This is not a v0.x issue.
  • I have searched the issues of this repository and believe that this is not a duplicate.

I believe this is linked to #14561 though, but as it's already merged, I think it needs a new issue.

Expected Behavior 🤔

The description for the size property should be:

Specify the size of the cell. By default, the Table parent component set the value (medium).

The description for the CSS class sizeSmall should be:

Styles applied to the root element if size="small".

Current Behavior 😯

For the size property, the description is:

Specify the size of the cell. By default, the Table parent component set the value (normal).

For the CSS class sizeSmall, the description is:

Styles applied to the root element if padding="dense".

Steps to Reproduce 🕹

Link: TableCell's doc

  1. In Props, look for size property's description
  2. In CSS, look for sizeSmall class' description

Context 🔦

I was following the v3 to v4 migration guide, part about Table/TableCell and went to the TableCell's doc.

Your Environment 🌎

Tech Version
Material-UI v4.1.3
React v16.8.6
Browser Firefox 67.0.4

Edit: Modified issue to use Bug report template, even if it's not really a bug, nor a feature request, but more a doc improvement suggestion.

@oliviertassinari
Copy link
Member

@the-question You gonna need to be explicit. I don't understand what you are trying to communicate. Please use our issue template, otherwise, you take the risk to be ignored. Thank you!

@oliviertassinari oliviertassinari added the status: waiting for author Issue with insufficient information label Jun 25, 2019
@the-question
Copy link
Contributor Author

@oliviertassinari Thank you for the advice.
If it is indeed the doc that should be updated, I think the only needed change is in the TableCell PropTypes comments.
If you confirm and want me to create a PR with the 2 changes described in the Expected Behavior, I can do it.

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process. and removed status: waiting for author Issue with insufficient information labels Jun 25, 2019
@oliviertassinari
Copy link
Member

@the-question Thanks for taking the time to follow our template. I agree, I think that the descriptions should be updated as sugested :).

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 good first issue Great for first contributions. Enable to learn the contribution process.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants