docs(table component): Improve instructions on sorting #13658
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
googlebot
added
the
cla: yes
crisbeto
reviewed
Oct 18, 2018
src/lib/table/table.md
Outdated
| @@ -138,7 +138,7 @@ and its interface is not tied to any one specific implementation. | |||
| #### Sorting | |||
|
|
|||
| 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)). | |||
There was a problem hiding this comment.
"initialise" -> "initialize". We're using the US spelling.
src/lib/table/table.md
Outdated
| @@ -138,7 +138,7 @@ and its interface is not tied to any one specific implementation. | |||
| #### Sorting | |||
|
|
|||
| 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)). | |||
There was a problem hiding this comment.
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...".
crisbeto
added
pr: lgtm
action: merge
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #13197
Best regards,
Benedikt