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

[core] Clean error messages prefix #2676

Merged
merged 20 commits into from
Oct 1, 2021

Conversation

flaviendelangle
Copy link
Member

Closes #2631

@m4theushw
Copy link
Member

Do you plan to also update the documentation?

@oliviertassinari
Copy link
Member

oliviertassinari commented Sep 23, 2021

In the issue description, I didn't try to provide a comprehensive list of the type of references that needs to be updated. I would encourage to do a global search for Material-UI and https://material-ui.com.

@flaviendelangle
Copy link
Member Author

I can update this pr with the other cases yes

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/pages/api-docs/data-grid/data-grid-pro.md Outdated Show resolved Hide resolved
@@ -132,7 +132,7 @@ You can use the [slots API](/components/data-grid/components/#overriding-compone

| Name | Type | Default | Description |
|:-----|:-----|:--------|:------------|
| <span class="prop-name">Checkbox</span> | <span class="prop-type">elementType</span> | <span class="prop-type">Checkbox</span> | Checkbox component used in the grid for both header and cells. By default, it uses the Material-UI core Checkbox component. |
| <span class="prop-name">Checkbox</span> | <span class="prop-type">elementType</span> | <span class="prop-type">Checkbox</span> | Checkbox component used in the grid for both header and cells. By default, it uses the MUI core Checkbox component. |
Copy link
Member

@oliviertassinari oliviertassinari Sep 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| <span class="prop-name">Checkbox</span> | <span class="prop-type">elementType</span> | <span class="prop-type">Checkbox</span> | Checkbox component used in the grid for both header and cells. By default, it uses the MUI core Checkbox component. |
| <span class="prop-name">Checkbox</span> | <span class="prop-type">elementType</span> | <span class="prop-type">Checkbox</span> | Checkbox component used in the grid for both header and cells. By default, it uses the MUI Core Checkbox component. |

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the difference between the two lines here ?

Copy link
Member

@oliviertassinari oliviertassinari Sep 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was the same, oops, updated. I wondered about the capitalization of the MUI Core.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we approved this one, could we update the whole codebase? I assume that the source of truth for this one is in the TypeScript' descriptions.

Copy link
Member

@m4theushw m4theushw Sep 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we approved this one, could we update the whole codebase? I assume that the source of truth for this one is in the TypeScript' descriptions.

I think it's not worth to waste time updating the manually authored API pages now. The documentation for this component can be automatically generated in #2465. BTW, the TypeScript definition doesn't have the "By default, it uses the MUI..." part.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW, the TypeScript definition doesn't have the "By default, it uses the MUI..." part.

Oh nice, +1 for ignoring the api .md files and focusing on the TypeScript definition. It started to diverge on this instance with #1528.

flaviendelangle and others added 5 commits September 27, 2021 17:33
Co-authored-by: Olivier Tassinari <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation core Infrastructure work going on behind the scenes labels Sep 27, 2021
@flaviendelangle flaviendelangle merged commit e3be5cf into mui:next Oct 1, 2021
@flaviendelangle flaviendelangle deleted the error-messages branch October 1, 2021 19:04
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Material-UI SAS
Copyright (c) 2021 Material-UI SAS
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK, this change is not correct, see https://opensource.stackexchange.com/questions/6389/how-do-the-years-specified-in-a-copyright-statement-work for why. It's meant to signal the first year when the content was created.

@mbrookes A preference on what we should do? Like React or

Suggested change
Copyright (c) 2021 Material-UI SAS
Copyright (c) Material-UI SAS

or as before, the first year

Suggested change
Copyright (c) 2021 Material-UI SAS
Copyright (c) 2020 Material-UI SAS

or a range

Suggested change
Copyright (c) 2021 Material-UI SAS
Copyright (c) 2020-2021 Material-UI SAS

?

I would be leaning to revert, match what we do in the core.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, missed this. Consistent with the core makes sense.

One problem with the year of creation is that it doesn't strictly apply to source code that is changed over the years, unlike say a book which is published in a particular year, and doesn't change. That said, it doesn't much matter, as copyright is implicit, and by the time the copyright expires on the first commits, we'll be beyond caring. Not to mention, for open source, copyright doesn't hold much meaning.

Comment on lines +1 to +5
import * as React from 'react';

export default function Playground() {
return <div>This file is listed in `.gitignore`</div>;
}
Copy link
Member

@oliviertassinari oliviertassinari Oct 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would have been better as a tsx file, done in #2755.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Material-UI -> MUI renaming in the codebase
5 participants