Skip to content

Commit 8ec27b7

Browse files
author
Desislava Mihaylova
committed
docs(cldr): improve on the layout
1 parent 321e2cc commit 8ec27b7

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

docs/cldr/api.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The CLDR data to be loaded. Multiple parameters are accepted.
2424

2525
## firstDay Method
2626

27-
Returns the first day index starting from Sunday based on the specified locale.
27+
Returns the first day index starting from Sunday and based on the specified locale.
2828

2929
### firstDay Parameters
3030

@@ -54,25 +54,39 @@ The options that determine the returned names.
5454

5555
#### options.type `String`
5656

57-
The type of the names. The supported values are `"eras"`, `"quarters"`, `"months"`, `"days"` and `"dayPeriods"`.
57+
The type of the names.
58+
59+
The supported values are:
60+
* `"eras"`
61+
* `"quarters"`
62+
* `"months"`
63+
* `"days"`
64+
* `"dayPeriods"`
5865

5966
#### options.nameType `String`
6067

61-
The format name type. The supported values are `"abbreviated"`, `"wide"`, `"narrow"`. `"short"` can also be specified for `days`.
68+
The format name type.
69+
70+
The supported values are:
71+
* `"abbreviated"`
72+
* `"wide"`
73+
* `"narrow"`
74+
75+
The `"short"` option can also be specified for `days`.
6276

6377
#### options.standAlone `Boolean`
6478

65-
Indicates whether the stand-alone names should be returned.
79+
Indicates whether the standalone names should be returned.
6680

6781
### dateFormatNames Return Value
6882

6983
#### Returns `Object|Array`
7084

71-
The names. An object will be returned it the type is `"dayPeriods"` or `"eras"`. For the other types the result is `Array`.
85+
The names. An object will be returned if the type is `"dayPeriods"` or `"eras"`. For the other types, the result is `Array`.
7286

7387
## numberSymbols Method
7488

75-
Returns the number symbols from specified locale.
89+
Returns the number symbols from the specified locale.
7690

7791
### numberSymbols Parameters
7892

@@ -84,4 +98,4 @@ The locale id.
8498

8599
#### Returns `Object`
86100

87-
An object holding the locale number symbols.
101+
An object holding the number symbols from the specified locale.

0 commit comments

Comments
 (0)