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][data grid] Copyedit the Aggregation doc #16200

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

samuelsycamore
Copy link
Contributor

@samuelsycamore samuelsycamore commented Jan 15, 2025

Part of the ongoing auditing/editing project, prioritizing Premium and Pro docs.

This page has undergone an editorial review in the recent past so it's mostly in good shape already, but I did find some quick and easy improvements to make, such as writing an informative intro, tweaking the header architecture, and rephrasing things from future to present tense.

@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! enhancement This is not a bug, nor a new feature labels Jan 15, 2025
@mui-bot
Copy link

mui-bot commented Jan 15, 2025

@samuelsycamore samuelsycamore marked this pull request as ready for review January 16, 2025 17:48
@samuelsycamore samuelsycamore added the feature: Aggregation Related to the data grid Aggregation feature label Jan 16, 2025

You can aggregate rows through the Data Grid interface by opening the column menu and selecting from the items under **Aggregation**.
The Data Grid Premium provides tools to give end users the ability to aggregate and compare row values.
It includes [built-in functions](#built-in-functions) to cover common use cases such as sum, average, minimum, and maximum, as well as the means to [create custom functions](#creating-custom-functions) for all other needs.
Copy link
Member

Choose a reason for hiding this comment

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

not sure if there should be a , here

Suggested change
It includes [built-in functions](#built-in-functions) to cover common use cases such as sum, average, minimum, and maximum, as well as the means to [create custom functions](#creating-custom-functions) for all other needs.
It includes [built-in functions](#built-in-functions) to cover common use cases such as sum, average, minimum and maximum, as well as the means to [create custom functions](#creating-custom-functions) for all other needs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's called an Oxford (or serial) comma, and I'm a big fan of it. 😁 It seems like a very minor detail but English can be a pretty ambiguous language so I always prefer to err on the side of clarity. In one case, the lack of an Oxford comma in an employment contract led to a successful multi-million-dollar lawsuit!

docs/data/data-grid/aggregation/aggregation.md Outdated Show resolved Hide resolved
docs/data/data-grid/aggregation/aggregation.md Outdated Show resolved Hide resolved
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 enhancement This is not a bug, nor a new feature feature: Aggregation Related to the data grid Aggregation feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants