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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] Unions in callback parameters contain escape artifacts #26547

Closed
eps1lon opened this issue Jun 1, 2021 · 1 comment 路 Fixed by #26579
Closed

[docs] Unions in callback parameters contain escape artifacts #26547

eps1lon opened this issue Jun 1, 2021 · 1 comment 路 Fixed by #26579
Assignees
@eps1lon
Labels
bug 馃悰 Something doesn't work docs Improvements or additions to the documentation

Comments

@eps1lon
Copy link
Member

eps1lon commented Jun 1, 2021

Current Behavior 馃槸

onChange(value: T \| T[])

Expected Behavior 馃

onChange(value: T | T[])

i.e. no escaping artifact of |

-onChange(value: T \| T[])
+onChange(value: T | T[])

Steps to Reproduce 馃暪

Steps:

  1. Goto https://60b5eb9b8408a50008097c42--material-ui.netlify.app/api/autocomplete/
  2. Check description of onChange prop

Context 馃敠

Noticed in #26542 (comment)
@eps1lon eps1lon added bug 馃悰 Something doesn't work docs Improvements or additions to the documentation labels Jun 1, 2021
@eps1lon eps1lon self-assigned this Jun 1, 2021
@eps1lon eps1lon mentioned this issue Jun 1, 2021
Merged
@oliviertassinari
Copy link
Member

I believe this \\ was added so that | doesn't break the markdown table. We render in React now. It could be this:

https://github.com/mui-org/material-ui/blob/6f43dd902de99947af7938af5cb61543c6797ca3/docs/scripts/buildApi.ts#L216

@eps1lon eps1lon mentioned this issue Jun 3, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eps1lon eps1lon

Labels
bug 馃悰 Something doesn't work docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs] Don't escape prop descriptions for markdown table context eps1lon/material-ui
2 participants
@oliviertassinari @eps1lon