Skip to content

Commit 49f54fe

Browse files
dmihaylotsvetomir
authored andcommitted
docs: add more links
1 parent 6220be9 commit 49f54fe

File tree

5 files changed

+56
-36
lines changed

5 files changed

+56
-36
lines changed

docs/date-formatting/api.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,15 @@ position: 2
1010

1111
Provides information about the exported methods from the Date Formatting module.
1212

13+
{% platform_content angular %}
14+
For a runnable example, refer to the article on [date and number formatting and parsing]({% parsingandformatting_intl %}#toc-date-formatting).
15+
{% endplatform_content %}
16+
1317
## Methods
1418

1519
#### formatDate
1620

17-
Converts a `Date` object into a string based on the specified format and locale ([see example](https://github.com/telerik/kendo-intl/blob/master/docs/date-formatting/index.md).
21+
Converts a `Date` object into a string based on the specified format and locale ([more information](https://github.com/telerik/kendo-intl/blob/master/docs/date-formatting/index.md).
1822

1923
## Parameters
2024

@@ -32,7 +36,7 @@ Defines the skeleton format used to get the pattern from the locale calendar [`a
3236

3337
#### format.date `String`
3438

35-
Specifies which of the locale `dateFormats` should be used to format the value.
39+
Specifies which of the locale `dateFormats` will be used to format the value.
3640

3741
The supported values are:
3842
* `"short"`
@@ -42,7 +46,7 @@ The supported values are:
4246

4347
#### format.time `String`
4448

45-
Specifies which of the locale `timeFormats` should be used to format the value.
49+
Specifies which of the locale `timeFormats` will be used to format the value.
4650

4751
The supported values are:
4852
* `"short"`
@@ -52,7 +56,7 @@ The supported values are:
5256

5357
#### format.datetime `String`
5458

55-
Specifies which of the locale `dateTimeFormats` should be used to format the value.
59+
Specifies which of the locale `dateTimeFormats` will be used to format the value.
5660

5761
The supported values are:
5862
* `"short"`
@@ -62,7 +66,7 @@ The supported values are:
6266

6367
#### format.era `String`
6468

65-
Specifies how should the date era be formatted.
69+
Specifies how will the date era be formatted.
6670

6771
The supported values are:
6872
* `"narrow"`
@@ -71,15 +75,15 @@ The supported values are:
7175

7276
#### format.year `String`
7377

74-
Specifies how the date year should be formatted.
78+
Specifies how the date year will be formatted.
7579

7680
The supported values are:
7781
* `"numeric"`
7882
* `"2-digit"`
7983

8084
#### format.month `String`
8185

82-
Specifies how the date month should be formatted.
86+
Specifies how the date month will be formatted.
8387

8488
The supported values are:
8589
* `"numeric"`
@@ -90,15 +94,15 @@ The supported values are:
9094

9195
#### format.day `String`
9296

93-
Specifies how the day of the month should be formatted.
97+
Specifies how the day of the month will be formatted.
9498

9599
The supported values are:
96100
* `"numeric"`
97101
* `"2-digit"`
98102

99103
#### format.weekday `String`
100104

101-
Specifies how the day of the week should be formatted.
105+
Specifies how the day of the week will be formatted.
102106

103107
The supported values are:
104108
* `"narrow"`
@@ -107,7 +111,7 @@ The supported values are:
107111

108112
#### format.weekday `String`
109113

110-
Specifies how the day of the week should be formatted.
114+
Specifies how the day of the week will be formatted.
111115

112116
The supported values are:
113117
* `"narrow"`
@@ -116,35 +120,35 @@ The supported values are:
116120

117121
#### format.hour `String`
118122

119-
Specifies how the hours should be formatted.
123+
Specifies how the hours will be formatted.
120124

121125
The supported values are:
122126
* `"numeric"`
123127
* `"2-digit"`
124128

125129
#### format.hour12 `Boolean`
126130

127-
Specifies if a 12-hour time set should be used for the formatting.
131+
Specifies if a 12-hour time set will be used for the formatting.
128132

129133
#### format.minute `String`
130134

131-
Specifies how the minutes should be formatted.
135+
Specifies how the minutes will be formatted.
132136

133137
The supported values are:
134138
* `"numeric"`
135139
* `"2-digit"`
136140

137141
#### format.second `String`
138142

139-
Specifies how the seconds should be formatted.
143+
Specifies how the seconds will be formatted.
140144

141145
The supported values are:
142146
* `"numeric"`
143147
* `"2-digit"`
144148

145149
#### format.timeZoneName `String`
146150

147-
Specifies how the timezone should be formatted.
151+
Specifies how the timezone will be formatted.
148152

149153
The supported values are:
150154
* `"short"`
@@ -162,7 +166,7 @@ The formatted date.
162166

163167
#### splitDateFormat
164168

165-
Returns information about the individual segments of a format. The returned objects contain the segment type (for example, year or month), the pattern, and the information about the [dateFormatNames](https://github.com/telerik/kendo-intl/blob/master/docs/cldr/api.md#dateformatnames) that are used for the pattern.
169+
Returns information about the individual segments of a format. The returned objects contain the segment type (for example, year or month), the pattern, and the information about the [`dateFormatNames`](https://github.com/telerik/kendo-intl/blob/master/docs/cldr/api.md#dateformatnames) that are used for the pattern.
166170

167171
## Parameters
168172

docs/date-parsing/api.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,15 @@ position: 2
1010

1111
Provides information about the exported methods from the Date Parsing module.
1212

13+
{% platform_content angular %}
14+
For a runnable example, refer to the article on [date and number formatting and parsing]({% parsingandformatting_intl %}#toc-date-parsing).
15+
{% endplatform_content %}
16+
1317
## Methods
1418

1519
#### parseDate
1620

17-
Converts a string into a `Date` object based on the specified format and locale ([see example](https://github.com/telerik/kendo-intl/blob/master/docs/date-parsing/index.md).
21+
Converts a string into a `Date` object based on the specified format and locale ([more information](https://github.com/telerik/kendo-intl/blob/master/docs/date-parsing/index.md).
1822

1923
## Parameters
2024

@@ -32,7 +36,7 @@ Defines the skeleton format used to get the pattern from the locale calendar [`a
3236

3337
#### format.date `String`
3438

35-
Specifies which of the locale `dateFormats` should be used to format the value.
39+
Specifies which of the locale `dateFormats` will be used to format the value.
3640

3741
The supported values are:
3842
* `"short"`
@@ -42,7 +46,7 @@ The supported values are:
4246

4347
#### format.time `String`
4448

45-
Specifies which of the locale `timeFormats` should be used to format the value.
49+
Specifies which of the locale `timeFormats` will be used to format the value.
4650

4751
The supported values are:
4852
* `"short"`
@@ -52,7 +56,7 @@ The supported values are:
5256

5357
#### format.datetime `String`
5458

55-
Specifies which of the locale `dateTimeFormats` should be used to format the value.
59+
Specifies which of the locale `dateTimeFormats` will be used to format the value.
5660

5761
The supported values are:
5862
* `"short"`
@@ -62,7 +66,7 @@ The supported values are:
6266

6367
#### format.era `String`
6468

65-
Specifies how the date era should be formatted.
69+
Specifies how the date era will be formatted.
6670

6771
The supported values are:
6872
* `"narrow"`
@@ -71,15 +75,15 @@ The supported values are:
7175

7276
#### format.year `String`
7377

74-
Specifies how the date year should be formatted.
78+
Specifies how the date year will be formatted.
7579

7680
The supported values are:
7781
* `"numeric"`
7882
* `"2-digit"`
7983

8084
#### format.month `String`
8185

82-
Specifies how the date month should be formatted.
86+
Specifies how the date month will be formatted.
8387

8488
The supported values are:
8589
* `"numeric"`
@@ -90,15 +94,15 @@ The supported values are:
9094

9195
#### format.day `String`
9296

93-
Specifies how the day of the month should be formatted.
97+
Specifies how the day of the month will be formatted.
9498

9599
The supported values are:
96100
* `"numeric"`
97101
* `"2-digit"`
98102

99103
#### format.weekday `String`
100104

101-
Specifies how the day of the week should be formatted.
105+
Specifies how the day of the week will be formatted.
102106

103107
The supported values are:
104108
* `"narrow"`
@@ -107,7 +111,7 @@ The supported values are:
107111

108112
#### format.weekday `String`
109113

110-
Specifies how the day of the week should be formatted.
114+
Specifies how the day of the week will be formatted.
111115

112116
The supported values are:
113117
* `"narrow"`
@@ -116,35 +120,35 @@ The supported values are:
116120

117121
#### format.hour `String`
118122

119-
Specifies how the hours should be formatted.
123+
Specifies how the hours will be formatted.
120124

121125
The supported values are:
122126
* `"numeric"`
123127
* `"2-digit"`
124128

125129
#### format.hour12 `Boolean`
126130

127-
Specifies if a 12-hour time set should be used for the formatting.
131+
Specifies if a 12-hour time set will be used for the formatting.
128132

129133
#### format.minute `String`
130134

131-
Specifies how the minutes should be formatted.
135+
Specifies how the minutes will be formatted.
132136

133137
The supported values are:
134138
* `"numeric"`
135139
* `"2-digit"`
136140

137141
#### format.second `String`
138142

139-
Specifies how the seconds should be formatted.
143+
Specifies how the seconds will be formatted.
140144

141145
The supported values are:
142146
* `"numeric"`
143147
* `"2-digit"`
144148

145149
#### format.timeZoneName `String`
146150

147-
Specifies how the timezone should be formatted.
151+
Specifies how the timezone will be formatted.
148152

149153
The supported values are:
150154
* `"short"`

docs/general-formatting/api.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,17 @@ position: 2
88

99
# General Formatting API
1010

11-
Provides information about the exported methods from the format module.
11+
Provides information about the exported methods from the Format module.
12+
13+
{% platform_content angular %}
14+
For a runnable example, refer to the article on [date and number formatting and parsing]({% parsingandformatting_intl %}#toc-general-formatting).
15+
{% endplatform_content %}
1216

1317
## Methods
1418

1519
#### format
1620

17-
Replaces the format string placeholders with the provided values based on the index.
21+
Replaces the format string placeholders with the provided values based on the index ([more information](https://github.com/telerik/kendo-intl/blob/master/docs/general-formatting/index.md).
1822

1923
## Parameters
2024

@@ -24,7 +28,7 @@ The format string.
2428

2529
#### values `Array`
2630

27-
The values that should be replaced in the format string.
31+
The values that will be replaced in the format string.
2832

2933
#### locale `String`
3034

docs/num-formatting/api.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,15 @@ position: 2
1010

1111
Provides information about the exported methods from the Number Formatting module.
1212

13+
{% platform_content angular %}
14+
For a runnable example, refer to the article on [date and number formatting and parsing]({% parsingandformatting_intl %}#toc-number-formatting).
15+
{% endplatform_content %}
16+
1317
## Methods
1418

1519
### formatNumber
1620

17-
Converts a `Number` into a string based on the specified format and locale ([see example](https://github.com/telerik/kendo-intl/blob/master/docs/num-formatting/index.md).
21+
Converts a `Number` into a string based on the specified format and locale ([more information](https://github.com/telerik/kendo-intl/blob/master/docs/num-formatting/index.md).
1822

1923
## Parameters
2024

docs/num-parsing/api.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,15 @@ position: 2
1010

1111
Provides information about the exported methods from the Number Parsing module.
1212

13+
{% platform_content angular %}
14+
For a runnable example, refer to the article on [date and number formatting and parsing]({% parsingandformatting_intl %}#toc-number-parsing).
15+
{% endplatform_content %}
16+
1317
## Methods
1418

1519
### parseNumber
1620

17-
Converts a string into a `Number` based on the specified locale ([see example](https://github.com/telerik/kendo-intl/blob/master/docs/num-parsing/index.md).
21+
Converts a string into a `Number` based on the specified locale ([more information](https://github.com/telerik/kendo-intl/blob/master/docs/num-parsing/index.md).
1822

1923
## Parameters
2024

0 commit comments

Comments
 (0)