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] Fix some typos in charts docs #13906

Merged
merged 7 commits into from
Jul 24, 2024
Merged

[docs] Fix some typos in charts docs #13906

merged 7 commits into from
Jul 24, 2024

Conversation

cratiu222
Copy link
Contributor

Hello
I found some minor typos issues in your docs.
Br, Christina.

Signed-off-by: Christina <156356273+cratiu222@users.noreply.github.com>
Signed-off-by: Christina <156356273+cratiu222@users.noreply.github.com>
Signed-off-by: Christina <156356273+cratiu222@users.noreply.github.com>
Signed-off-by: Christina <156356273+cratiu222@users.noreply.github.com>
@mui-bot
Copy link

mui-bot commented Jul 19, 2024

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jul 19, 2024
Signed-off-by: Olivier Tassinari <olivier.tassinari@gmail.com>
@oliviertassinari oliviertassinari changed the title chore: fix typos [charts][docs] Fix typos Jul 19, 2024
@oliviertassinari oliviertassinari added component: charts This is the name of the generic UI component, not the React module! component: data grid This is the name of the generic UI component, not the React module! labels Jul 19, 2024
@oliviertassinari oliviertassinari changed the title [charts][docs] Fix typos [docs] Fix typos Jul 19, 2024
@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 19, 2024

I'm confused by the API. Why do we map yAxis.id with yAxisKey:

<LineChart
  xAxis={[{ data: sample }]}
  yAxis={[
    { id: 'linearAxis', scaleType: 'linear' },
    { id: 'logAxis', scaleType: 'log' },
  ]}
  series={[
    { yAxisKey: 'linearAxis', data: sample, label: 'linear' },
    { yAxisKey: 'logAxis', data: sample, label: 'log' },
  ]}
  leftAxis="linearAxis"
  rightAxis="logAxis"
  height={400}
/>

https://deploy-preview-13906--material-ui-x.netlify.app/x/react-charts/axis/#defining-axis

Why not:

<LineChart
  xAxis={[{ data: sample }]}
  yAxis={[
    { id: 'linearAxis', scaleType: 'linear' },
    { id: 'logAxis', scaleType: 'log' },
  ]}
  series={[
    { yAxisId: 'linearAxis', data: sample, label: 'linear' },
    { yAxisId: 'logAxis', data: sample, label: 'log' },
  ]}
  leftAxisId="linearAxis"
  rightAxisId="logAxis"
  height={400}
/>

or

<LineChart
  xAxis={[{ data: sample }]}
  yAxis={[
    { id: 'linearAxis', scaleType: 'linear' },
    { id: 'logAxis', scaleType: 'log' },
  ]}
  series={[
    { yAxis: 'linearAxis', data: sample, label: 'linear' },
    { yAxis: 'logAxis', data: sample, label: 'log' },
  ]}
  leftAxis="linearAxis"
  rightAxis="logAxis"
  height={400}
/>

Signed-off-by: Christina <156356273+cratiu222@users.noreply.github.com>
@arminmeh arminmeh self-requested a review July 22, 2024 09:30
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 24, 2024
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Signed-off-by: Jose C Quintas Jr <juniorquintas@gmail.com>
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 24, 2024
@JCQuintas JCQuintas changed the title [docs] Fix typos [docs] Fix some typos in charts docs Jul 24, 2024
@JCQuintas JCQuintas dismissed arminmeh’s stale review July 24, 2024 09:19

Request was fulfilled, dismissing so I can merge this.

@JCQuintas JCQuintas merged commit 63651e7 into mui:master Jul 24, 2024
17 checks passed
thomasmoon pushed a commit to thomasmoon/mui-x that referenced this pull request Sep 9, 2024
Signed-off-by: Christina <156356273+cratiu222@users.noreply.github.com>
Signed-off-by: Olivier Tassinari <olivier.tassinari@gmail.com>
Signed-off-by: Jose C Quintas Jr <juniorquintas@gmail.com>
Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>
Co-authored-by: Jose C Quintas Jr <juniorquintas@gmail.com>
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: charts This is the name of the generic UI component, not the React module! component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants