Skip to content

Commit

Permalink
docs: correct placement of param descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
jbogarthyde committed May 25, 2018
1 parent e3d0b77 commit 33c65d1
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions packages/common/src/pipes/date_pipe.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,6 @@ import {invalidPipeArgumentError} from './invalid_pipe_argument_error';
* WARNING: The pipe uses the Internationalization API, and is therefore
* only reliable in Chrome and Opera browsers.
*
* @param date_expression A date object or a number (milliseconds since UTC epoch)
* or an ISO string (https://www.w3.org/TR/NOTE-datetime).
* @param format A predefined or custom style that specifies which date-time components
* to include and how to display them. See details below.
* @returns A date string in the desired format.
*
* @usageNotes
*
* The result of this pipe is not re-evaluated when the input is mutated. To avoid the need to
Expand Down Expand Up @@ -159,14 +153,15 @@ export class DatePipe implements PipeTransform {
constructor(@Inject(LOCALE_ID) private locale: string) {}

/**
* @param date_expression A date object or a number (milliseconds since UTC epoch) or an ISO string
* (https://www.w3.org/TR/NOTE-datetime).
* @param value The date expression, a `Date` object or a number
* (milliseconds since UTC epoch) or an ISO string (https://www.w3.org/TR/NOTE-datetime).
* @param format The date/time components to include, using pre-defined options or a
* custom format string.
* @param timezone A time-zone offset (such as `'+0430'`), or a standard
* UTC/GMT or continental US time zone abbreviation. Deafault is
* the local system time zone of the end-user's machine.
* @param locale A locale identifier. Default is `LOCALE_ID`.
* @param locale A locale identifier. Default is `LOCALE_ID`.
* @returns A date string in the desired format.
*/
transform(value: any, format = 'mediumDate', timezone?: string, locale?: string): string|null {
if (value == null || value === '' || value !== value) return null;
Expand Down

0 comments on commit 33c65d1

Please sign in to comment.