Skip to content

docs(table component): Improve instructions on sorting - #13658

Merged
josephperrott merged 1 commit into
angular:masterfrom
benedikt-roth:task/improve-table-sort-docs
Oct 18, 2018
Merged

docs(table component): Improve instructions on sorting#13658
josephperrott merged 1 commit into
angular:masterfrom
benedikt-roth:task/improve-table-sort-docs

Conversation

@benedikt-roth

Copy link
Copy Markdown
Contributor

Fixes#13197

Best regards,
Benedikt

@googlebotgooglebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Oct 17, 2018
Comment threadsrc/lib/table/table.md Outdated

To add sorting behavior to the table, add the `matSort` directive to the table and add
`mat-sort-header` to each column header cell that should trigger sorting.
`mat-sort-header` to each column header cell that should trigger sorting. Do not forget to import `MatSortModule` in order to initialise the `matSort` directive (see [API docs](https://material.angular.io/components/sort/api)).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

"initialise" -> "initialize". We're using the US spelling.

Comment threadsrc/lib/table/table.md Outdated

To add sorting behavior to the table, add the `matSort` directive to the table and add
`mat-sort-header` to each column header cell that should trigger sorting.
`mat-sort-header` to each column header cell that should trigger sorting. Do not forget to import `MatSortModule` in order to initialise the `matSort` directive (see [API docs](https://material.angular.io/components/sort/api)).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This would be a little more friendly if it was written like "Note that you have to import the MatSortModule...", rather than "Do not forget...".

@crisbetocrisbeto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@crisbetocrisbeto added pr: lgtm action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release labels Oct 18, 2018
@josephperrott
josephperrott merged commit e48a6a9 into angular:masterOct 18, 2018
@angular-automatic-lock-bot

Copy link
Copy Markdown

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-botangular-automatic-lock-botBot locked and limited conversation to collaborators Sep 9, 2019
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: mergeThe PR is ready for merge by the caretakercla: yesPR author has agreed to Google's Contributor License Agreementtarget: patchThis PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

update table with sorting docs to include MatSortModule

4 participants

@benedikt-roth@crisbeto@googlebot@josephperrott