Skip to content

docs: fixed minor typos and table formatting #18042

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

Merged
merged 1 commit into from
Dec 29, 2019
Merged

docs: fixed minor typos and table formatting #18042

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ descriptions.
## Are there any updates on issue _X_?

Any issue updates will appear on the issue. Due to the large volume of issues and feature requests
recieved by the team, we aren't able to regularly comment on all open issues and PRs.
received by the team, we aren't able to regularly comment on all open issues and PRs.

## Why hasn't PR _X_ been merged?

Expand All @@ -27,7 +27,7 @@ When tests fail, however, the team has to spend time investigating before the PR
Because of this, we cannot merge any PRs that would break an existing project. If a PR has extensive
failures, it may be put on the backburner until the team can schedule time to debug the full extent
of the issue. If a PR seems ready to merge, but has been inactive, it has very likely
encountered some test failures inside Google that must be resovled first.
encountered some test failures inside Google that must be resolved first.

## Why aren't you working on _X_?

Expand Down
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
The Angular team builds and maintains both common UI components and tools to help you build your
own custom components. The team maintains several npm packages.

| Package | Description | Docs |
|---------------------------|------------------------------------------------------------------------------------|------------------|
| `@angular/cdk` | Library that helps you author custom UI components with common interation patterns | [Docs][cdk-docs] |
| `@angular/material` | [Material Design][] UI components for Angular applications | [Docs][mat-docs] |
| `@angular/google-maps` | Angular components built on top of the [Google Maps JavaScript API][] | [Docs][map-docs] |
| `@angular/youtube-player` | Angular component built on top of the [YouTube Player API][] | [Docs][ytp-docs] |
| Package | Description | Docs |
| ------------------------- | ----------------------------------------------------------------------------------- | ---------------- |
| `@angular/cdk` | Library that helps you author custom UI components with common interaction patterns | [Docs][cdk-docs] |
| `@angular/material` | [Material Design][] UI components for Angular applications | [Docs][mat-docs] |
| `@angular/google-maps` | Angular components built on top of the [Google Maps JavaScript API][] | [Docs][map-docs] |
| `@angular/youtube-player` | Angular component built on top of the [YouTube Player API][] | [Docs][ytp-docs] |


#### Quick links
Expand Down
26 changes: 13 additions & 13 deletions src/material/card/card.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ The most basic card needs only an `<mat-card>` element with some content. Howeve
provides a number of preset sections that you can use inside of an `<mat-card>`:


| Element | Description |
|-----------------------|--------------------------------------------------------------------------|
| `<mat-card-title>` | Card title |
| `<mat-card-subtitle>` | Card subtitle |
| `<mat-card-content>` | Primary card content. Intended for blocks of text |
| `<img mat-card-image>` | Card image. Stretches the image to the container width |
| `<mat-card-actions>` | Container for buttons at the bottom of the card |
| `<mat-card-footer>` | Section anchored to the bottom of the card |
| Element | Description |
| ---------------------- | ------------------------------------------------------ |
| `<mat-card-title>` | Card title |
| `<mat-card-subtitle>` | Card subtitle |
| `<mat-card-content>` | Primary card content. Intended for blocks of text |
| `<img mat-card-image>` | Card image. Stretches the image to the container width |
| `<mat-card-actions>` | Container for buttons at the bottom of the card |
| `<mat-card-footer>` | Section anchored to the bottom of the card |

These elements primary serve as pre-styled content containers without any additional APIs.
However, the `align` property on `<mat-card-actions>` can be used to position the actions at the
Expand All @@ -26,11 +26,11 @@ However, the `align` property on `<mat-card-actions>` can be used to position th
In addition to the aforementioned sections, `<mat-card-header>` gives the ability to add a rich
header to a card. This header can contain:

| Element | Description |
|------------------------|-------------------------------------------------------------------------|
| `<mat-card-title>` | A title within the header |
| `<mat-card-subtitle>` | A subtitle within the header |
| `<img mat-card-avatar>` | An image used as an avatar within the header |
| Element | Description |
| ----------------------- | -------------------------------------------- |
| `<mat-card-title>` | A title within the header |
| `<mat-card-subtitle>` | A subtitle within the header |
| `<img mat-card-avatar>` | An image used as an avatar within the header |


### Title groups
Expand Down
2 changes: 1 addition & 1 deletion src/material/icon/icon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ match the current theme's colors using the `color` attribute. This can be change
Similar to an `<img>` element, an icon alone does not convey any useful information for a
screen-reader user. The user of `<mat-icon>` must provide additional information pertaining to how
the icon is used. Based on the use-cases described below, `mat-icon` is marked as
`aria-hidden="true"` by default, but this can be overriden by adding `aria-hidden="false"` to the
`aria-hidden="true"` by default, but this can be overridden by adding `aria-hidden="false"` to the
element.

In thinking about accessibility, it is useful to place icon use into one of three categories:
Expand Down