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] Enforce no trailing spaces #34762

Merged

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Oct 14, 2022

It's a continuation of this discussion #34686. The value is about being able to more accurately understand how the markdown will render. A double space for adding a line break is almost invisible during the PR reviews but \ is visible.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Oct 14, 2022
@@ -11,7 +11,7 @@ module.exports = {
// closing double quote: \xE2\x80\x9D
if (line.match('[‘’“”]')) {
onError({
lineNumber,
lineNumber: lineNumber + 1,
Copy link
Member Author

@oliviertassinari oliviertassinari Oct 14, 2022

Choose a reason for hiding this comment

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

This was wrong, see how the lint failed with the wrong error message:

docs/pages/blog/mui-x-v6-alpha-zero.md:9 straightQuotes Only allow straight quotes. [This rule threw an exception: Property 'lineNumber' of onError parameter is incorrect.]

https://app.circleci.com/pipelines/github/mui/material-ui/82682/workflows/e4325483-1c91-4fd7-9074-a018208f590b/jobs/437682.

Comment on lines -886 to -890

:::warning
For [Storybook](https://storybook.js.org): At the time of this writing, Storybook still uses Emotion 10 by default.
Material UI and TSS use Emotion 11, so you must make [some changes](https://github.com/InseeFrLab/onyxia-ui/blob/324de62248074582b227e584c53fb2e123f5325f/.storybook/main.js#L31-L32) to `.storybook/main.js` in order to use Storybook with Material UI.
:::
Copy link
Member Author

@oliviertassinari oliviertassinari Oct 14, 2022

Choose a reason for hiding this comment

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

I don't think that mentioning Storybook makes sense in the context of style library interoperability, plus the content is outdated now: https://twitter.com/storybookjs/status/1578033180883693568.

@mui-bot
Copy link

mui-bot commented Oct 14, 2022

Messages
📖 Netlify deploy preview: https://deploy-preview-34762--material-ui.netlify.app/

No bundle size changes

Generated by 🚫 dangerJS against 1bf301a

'**/node_modules/**',
'**/*-zh.md',
'**/*-pt.md',
'**/build/**',
Copy link
Member Author

@oliviertassinari oliviertassinari Oct 14, 2022

Choose a reason for hiding this comment

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

I have missed this, for those that do releases locally, they had a couple of changelogs in the build that fail the lining rule.

@oliviertassinari oliviertassinari requested a review from a team October 14, 2022 21:08
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 14, 2022
@oliviertassinari oliviertassinari force-pushed the enforce-no-trailing-spaces branch from 6c127e4 to 273c99d Compare October 14, 2022 21:16
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 14, 2022
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 18, 2022
@oliviertassinari oliviertassinari force-pushed the enforce-no-trailing-spaces branch from 273c99d to b9cce50 Compare October 21, 2022 15:08
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Oct 21, 2022
@oliviertassinari oliviertassinari force-pushed the enforce-no-trailing-spaces branch from b9cce50 to 1bf301a Compare October 21, 2022 15:10
@oliviertassinari oliviertassinari merged commit c1ae102 into mui:master Oct 21, 2022
@oliviertassinari oliviertassinari deleted the enforce-no-trailing-spaces branch October 21, 2022 15:49
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
feliperli pushed a commit to jesrodri/material-ui that referenced this pull request Dec 6, 2022
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants