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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] Use "cannot" instead of "can't" or "can not" #11986

Merged
merged 4 commits into from
Feb 8, 2024
Merged

[docs] Use "cannot" instead of "can't" or "can not" #11986

merged 4 commits into from
Feb 8, 2024

Conversation

flaviendelangle
Copy link
Member

@flaviendelangle flaviendelangle self-assigned this Feb 8, 2024
@flaviendelangle flaviendelangle added the docs Improvements or additions to the documentation label Feb 8, 2024
@mui-bot
Copy link

mui-bot commented Feb 8, 2024 •
edited
Loading

Deploy preview: https://deploy-preview-11986--material-ui-x.netlify.app/

Updated pages:

Generated by 🚫 dangerJS against 37b0a96

@flaviendelangle flaviendelangle marked this pull request as ready for review February 8, 2024 09:25
LukasTy
LukasTy approved these changes Feb 8, 2024
View reviewed changes
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

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

WDYT about adding these rules to the ComposedWords.yml so that we could more easily spot such inconsistencies in the future? 🤔

  • "can't": cannot
  • "can not": cannot

docs/data/data-grid/row-grouping/row-grouping.md Outdated Show resolved Hide resolved
@flaviendelangle
Copy link
Member Author

WDYT about adding these rules to the ComposedWords.yml so that we could more easily spot such inconsistencies in the future? 🤔

Great idea!

@michelengelen
Copy link
Member

michelengelen commented Feb 8, 2024 •
edited
Loading

WDYT about adding these rules to the ComposedWords.yml so that we could more easily spot such inconsistencies in the future? 🤔

Great idea!

That would also mean we miss this particular case:

In some cases, the `not` following `can` is in fact part of another phrase, such as "can not only"

EDIT: sry ... added the comment on the wrong thread! 🙇🏼

@LukasTy
Copy link
Member

LukasTy commented Feb 8, 2024

That would also mean we miss this particular case:

In some cases, the `not` following `can` is in fact part of another phrase, such as "can not only"

Very good observation. 👏
But vale does not produce a CI error, it's just an additional comment in the changed files for reviewers to notice and potentially signal to the author if it was missed. 🤔
Do you think that it is a problem?

@flaviendelangle
Copy link
Member Author

Since it's only a PR warning and not a CI failure, I agree with Lukas that as long as the formulation are not super common, having the rule is better.
We don't have a single "can not only" in our repo for instance
BUT if there is a "can not XXX" that is used several time in our doc then of course the rule should be removed

@michelengelen
Copy link
Member

Alright ... then its fine! 👍🏼

@flaviendelangle flaviendelangle merged commit 85aebeb into mui:next Feb 8, 2024
17 checks passed
@flaviendelangle flaviendelangle deleted the cannot-doc branch February 8, 2024 12:01
thomasmoon pushed a commit to thomasmoon/mui-x that referenced this pull request Sep 9, 2024
@flaviendelangle @LukasTy @thomasmoon
[docs] Use "cannot" instead of "can't" or "can not" (mui#11986)
a87685e 
Signed-off-by: Flavien DELANGLE <[email protected]>
Co-authored-by: Lukas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michelengelen michelengelen michelengelen approved these changes

@LukasTy LukasTy LukasTy approved these changes

Assignees

@flaviendelangle flaviendelangle

Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@flaviendelangle @mui-bot @michelengelen @LukasTy