Skip to content

Commit 8a7c7c4

Browse files
committed
Update README, on API simplify cldr.method to .method
1 parent 57613b6 commit 8a7c7c4

14 files changed

+26
-26
lines changed

README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -329,25 +329,25 @@ You must also load any portion of the CLDR data you plan to use in your library
329329

330330
1: Unresolved processing is **only available** after loading `cldr/unresolved.js` extension module.
331331

332-
- **`cldr = new Cldr( locale )`**
332+
- **`new Cldr( locale )`**
333333

334334
Create a new instance of Cldr.
335335

336336
[Read more...](doc/api/core/constructor.md)
337337

338-
- **`cldr.attributes`**
338+
- **`.attributes`**
339339

340340
Attributes is an Object created during instance initialization (construction), and are used internally by `.get()` to replace dynamic parts of an item path.
341341

342342
[Read more...](doc/api/core/attributes.md)
343343

344-
- **`cldr.get( path )`**
344+
- **`.get( path )`**
345345

346346
Get the item data given its path, or `undefined` if missing.
347347

348348
[Read more...](doc/api/core/get.md)
349349

350-
- **`cldr.main( path )`**
350+
- **`.main( path )`**
351351

352352
It's an alias for `.get([ "main/{languageId}", ... ])`.
353353

@@ -373,19 +373,19 @@ You must also load any portion of the CLDR data you plan to use in your library
373373

374374
[Read more...](doc/api/event/global_off.md)
375375

376-
- **`cldr.on( event, listener )`**
376+
- **`.on( event, listener )`**
377377

378378
Add a listener function to the specified event for this instance.
379379

380380
[Read more...](doc/api/event/on.md)
381381

382-
- **`cldr.once( event, listener )`**
382+
- **`.once( event, listener )`**
383383

384384
Add a listener function to the specified event for this instance. It will be automatically removed after it's first execution.
385385

386386
[Read more...](doc/api/event/once.md)
387387

388-
- **`cldr.off( event, listener )`**
388+
- **`.off( event, listener )`**
389389

390390
Remove a listener function from the specified event for this instance.
391391

@@ -401,39 +401,39 @@ You must also load any portion of the CLDR data you plan to use in your library
401401

402402
### cldr/supplemental.js
403403

404-
- **`cldr.supplemental( path )`**
404+
- **`.supplemental( path )`**
405405

406406
It's an alias for `.get([ "supplemental", ... ])`.
407407

408408
[Read more...](doc/api/supplemental.md)
409409

410-
- **`cldr.supplemental.timeData.allowed()`**
410+
- **`.supplemental.timeData.allowed()`**
411411

412412
Helper function. Return the supplemental timeData allowed of locale's territory.
413413

414414
[Read more...](doc/api/supplemental/time_data_allowed.md)
415415

416-
- **`cldr.supplemental.timeData.preferred()`**
416+
- **`.supplemental.timeData.preferred()`**
417417

418418
Helper function. Return the supplemental timeData preferred of locale's territory.
419419

420420
[Read more...](doc/api/supplemental/time_data_preferred.md)
421421

422-
- **`cldr.supplemental.weekData.firstDay()`**
422+
- **`.supplemental.weekData.firstDay()`**
423423

424424
Helper function. Return the supplemental weekData firstDay of locale's territory.
425425

426426
[Read more...](doc/api/supplemental/week_data_first_day.md)
427427

428-
- **`cldr.supplemental.weekData.minDays()`**
428+
- **`.supplemental.weekData.minDays()`**
429429

430430
Helper function. Return the supplemental weekData minDays of locale's territory as a Number.
431431

432432
[Read more...](doc/api/supplemental/week_data_min_days.md)
433433

434434
### cldr/unresolved.js
435435

436-
- **`cldr.get( path )`**
436+
- **`.get( path )`**
437437

438438
Overload (extend) `.get()` to get the item data or lookup by following [locale inheritance](http://www.unicode.org/reports/tr35/#Locale_Inheritance), set a local resolved cache if it's found (for subsequent faster access), or return `undefined`.
439439

doc/api/core/attributes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.attributes
1+
## .attributes
22

33
Attributes is an Object created during instance initialization (construction), and are used internally by `.get()` to replace dynamic parts of an item path.
44

doc/api/core/constructor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr = new Cldr( locale )
1+
## new Cldr( locale )
22

33
Create a new instance of Cldr.
44

doc/api/core/get.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.get( path )
1+
## .get( path )
22

33
Get the item data given its path, or `undefined` if missing.
44

doc/api/core/main.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.main( path )
1+
## .main( path )
22

33
It's an alias for `.get([ "main/{languageId}", ... ])`.
44

doc/api/event/off.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.off( event, listener )
1+
## .off( event, listener )
22

33
Removes a listener function from the specified event for this instance.
44

doc/api/event/on.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.on( event, listener )
1+
## .on( event, listener )
22

33
Add a listener function to the specified event for this instance.
44

doc/api/event/once.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.once( event, listener )
1+
## .once( event, listener )
22

33
Add a listener function to the specified event for this instance. It will be automatically removed after it's first execution.
44

doc/api/supplemental.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.supplemental( path )
1+
## .supplemental( path )
22

33
It's an alias for `.get([ "supplemental", ... ])`.
44

doc/api/supplemental/time_data_allowed.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.supplemental.timeData.allowed()
1+
## .supplemental.timeData.allowed()
22

33
Helper function. Return the supplemental timeData allowed of locale's territory.
44

doc/api/supplemental/time_data_preferred.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.supplemental.timeData.preferred()
1+
## .supplemental.timeData.preferred()
22

33
Helper function. Return the supplemental timeData preferred of locale's territory.
44

doc/api/supplemental/week_data_first_day.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.supplemental.weekData.firstDay()
1+
## .supplemental.weekData.firstDay()
22

33
Helper function. Return the supplemental weekData firstDay of locale's territory.
44

doc/api/supplemental/week_data_min_days.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.supplemental.weekData.minDays()
1+
## .supplemental.weekData.minDays()
22

33
Helper function. Return the supplemental weekData minDays of locale's territory as a Number.
44

doc/api/unresolved/get.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## cldr.get( path )
1+
## .get( path )
22

33
Overload (extend) `.get()` to get the item data or lookup by following [locale inheritance](http://www.unicode.org/reports/tr35/#Locale_Inheritance), set a local resolved cache if it's found (for subsequent faster access), or return `undefined`.
44

0 commit comments

Comments
 (0)