Skip to content

Commit

Permalink
fixup! docs: test api doc for pipes
Browse files Browse the repository at this point in the history
  • Loading branch information
jbogarthyde committed Jun 19, 2018
1 parent a4f7473 commit de33116
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions packages/common/src/pipes/case_conversion_pipes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import {invalidPipeArgumentError} from './invalid_pipe_argument_error';
@Pipe({name: 'lowercase'})
export class LowerCasePipe implements PipeTransform {
/**
* @param value The string to transform.
* @param value The string to transform to lower case.
*/
transform(value: string): string {
if (!value) return value;
Expand All @@ -53,7 +53,7 @@ const unicodeWordMatch =
* Transforms text to title case.
* Capitalizes the first letter of each word, and transforms the
* rest of the word to lower case.
* Words are delimited by any whitespace character, such a space, tab, or line-feed character.
* Words are delimited by any whitespace character, such as a space, tab, or line-feed character.
*
* @see `LowerCasePipe`
* @see `UpperCasePipe`
Expand All @@ -68,7 +68,7 @@ const unicodeWordMatch =
@Pipe({name: 'titlecase'})
export class TitleCasePipe implements PipeTransform {
/**
* @param value The string to transform.
* @param value The string to transform to title case.
*/
transform(value: string): string {
if (!value) return value;
Expand All @@ -89,7 +89,7 @@ export class TitleCasePipe implements PipeTransform {
@Pipe({name: 'uppercase'})
export class UpperCasePipe implements PipeTransform {
/**
* @param value The string to transform.
* @param value The string to transform to upper case.
*/
transform(value: string): string {
if (!value) return value;
Expand Down
6 changes: 3 additions & 3 deletions packages/common/src/pipes/date_pipe.ts
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ import {invalidPipeArgumentError} from './invalid_pipe_argument_error';
* These examples transform a date into various formats,
* assuming that `dateObj` is a JavaScript `Date` object for
* year: 2015, month: 6, day: 15, hour: 21, minute: 43, second: 11,
* given in the local time for the 'en-US' locale.
* given in the local time for the `en-US` locale.
*
* ```
* {{ dateObj | date }} // output is 'Jun 15, 2015'
Expand All @@ -130,15 +130,15 @@ import {invalidPipeArgumentError} from './invalid_pipe_argument_error';
*
* ### Usage example
*
* The following component uses a date pipe to display the current date in two different formats.
* The following component uses a date pipe to display the current date in different formats.
*
* ```
* @Component({
* selector: 'date-pipe',
* template: `<div>
* <p>Today is {{today | date}}</p>
* <p>Or if you prefer, {{today | date:'fullDate'}}</p>
* <p>The time is {{today | date:'jmZ'}}</p>
* <p>The time is {{today | date:'hmZ'}}</p>
* </div>`
* })
* // Get the current date and time as a date-time value.
Expand Down
2 changes: 1 addition & 1 deletion packages/common/src/pipes/number_pipe.ts
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ export class CurrencyPipe implements PipeTransform {
/**
*
* @param value The number to be formatted as currency.
* @param currencyCodeis the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code,
* @param currencyCode The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code,
* such as `USD` for the US dollar and `EUR` for the euro.
* @param display The format for the currency indicator. One of the following:
* - `code`: Show the code (such as `USD`).
Expand Down

0 comments on commit de33116

Please sign in to comment.