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] Copyedit the Data Grid cell selection page #16099

Merged
merged 22 commits into from
Jan 15, 2025

Conversation

samuelsycamore
Copy link
Contributor

@samuelsycamore samuelsycamore commented Jan 7, 2025

Part of the ongoing auditing/editing project—prioritizing Premium and Pro feature docs after Getting Started materials.

  • edits for grammar and style
  • adds informative headers
  • clarifies details on how to select cells
  • fixes typos and improves grammar in API descriptions

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation component: data grid This is the name of the generic UI component, not the React module! plan: Premium Impact at least one Premium user labels Jan 7, 2025
@mui-bot
Copy link

mui-bot commented Jan 7, 2025

@samuelsycamore samuelsycamore marked this pull request as ready for review January 9, 2025 00:42
Copy link
Member

@michelengelen michelengelen left a comment

Choose a reason for hiding this comment

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

I've never seen this - sentence connection ... is this a stylistic thing? 🤔

docs/data/data-grid/cell-selection/cell-selection.md Outdated Show resolved Hide resolved
@samuelsycamore
Copy link
Contributor Author

samuelsycamore commented Jan 14, 2025

I've never seen this - sentence connection ... is this a stylistic thing? 🤔

@michelengelen I believe you're referring to the em-dash "—", which looks like a standard hyphen in a monospace font. In this context it's connecting two closely related sentences/clauses—think of it as somewhere between a comma, a colon, and a semi-colon. You can also use two of them in the middle of a sentence—almost like you're interrupting yourself—to serve as a parenthetical or emphasize a point. MUI's style guide dictates that we use em-dashes with no spaces on either side — so this one would be incorrect.

If you're on a Mac, you can type an em-dash with Shift + Option + hyphen key. Sometimes people just use two hyphens--and some word processors will automatically convert that to an em-dash.

@michelengelen
Copy link
Member

I've never seen this - sentence connection ... is this a stylistic thing? 🤔

@michelengelen I believe you're referring to the em-dash "—", which looks like a standard hyphen in a monospace font. In this context it's connecting two closely related sentences/clauses—think of it as somewhere between a comma, a colon, and a semi-colon. You can also use two of them in the middle of a sentence—almost like you're interrupting yourself—to serve as a parenthetical or emphasize a point. MUI's style guide dictates that we use em-dashes with no spaces on either side — so this one would be incorrect.

If you're on a Mac, you can type an em-dash with Shift + Option + hyphen key. Sometimes people just use two hyphens--and some word processors will automatically convert that to an em-dash.

Thanks for the explanation @samuelsycamore ... something new learned. There is a similar pattern n German, but we do not use dashes, but rather sub-sentences (if that makes sense)

@samuelsycamore samuelsycamore merged commit a2c7b00 into mui:master Jan 15, 2025
18 checks passed
cherniavskii pushed a commit to cherniavskii/mui-x that referenced this pull request Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation plan: Premium Impact at least one Premium user
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants