Skip to content

Commit 3b5ee6b

Browse files
authored
docs: document Date input and add Notes section in time/iso-weeks-in-year
PR-URL: #12313 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent d2d12a1 commit 3b5ee6b

3 files changed

Lines changed: 18 additions & 3 deletions

File tree

lib/node_modules/@stdlib/time/iso-weeks-in-year/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,16 @@ num = isoWeeksInYear( 2017 );
5656

5757
<!-- /.usage -->
5858

59+
<section class="notes">
60+
61+
## Notes
62+
63+
- The function's return value is a generalization and does **not** take into account inaccuracies due to daylight savings conventions, crossing timezones, or other complications with time and dates.
64+
65+
</section>
66+
67+
<!-- /.notes -->
68+
5969
<section class="examples">
6070

6171
## Examples

lib/node_modules/@stdlib/time/iso-weeks-in-year/docs/repl.txt

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11

2-
{{alias}}( [year] )
2+
{{alias}}( [value] )
33
Returns the number of ISO weeks in a year according to the Gregorian
44
calendar.
55

66
By default, the function returns the number of ISO weeks in the current year
77
(according to local time). To determine the number of ISO weeks for a
88
particular year, provide either a year or a `Date` object.
99

10+
The function's return value is a generalization and does **not** take into
11+
account inaccuracies due to daylight savings conventions, crossing
12+
timezones, or other complications with time and dates.
13+
1014
Parameters
1115
----------
12-
year: integer (optional)
13-
Year.
16+
value: integer|Date (optional)
17+
Year or `Date` object.
1418

1519
Returns
1620
-------

lib/node_modules/@stdlib/time/iso-weeks-in-year/docs/types/index.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
* ## Notes
2525
*
2626
* - By default, the function returns the number of ISO weeks in the current year (according to local time). To determine the number of ISO weeks for a particular year, provide either a year or a `Date` object.
27+
* - The function's return value is a generalization and does **not** take into account inaccuracies due to daylight savings conventions, crossing timezones, or other complications with time and dates.
2728
*
2829
* @param value - year or `Date` object
2930
* @returns number of ISO weeks in a year

0 commit comments

Comments
 (0)