Skip to content

Commit b45c1c6

Browse files
committed
Add notes regarding generalization (resolves stdlib-js#146)
1 parent 59a9eaf commit b45c1c6

30 files changed

Lines changed: 207 additions & 0 deletions

File tree

lib/node_modules/@stdlib/constants/time/hours-in-day/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,16 @@ var bool = ( HOURS_IN_DAY === 24 );
4343

4444
<!-- /.usage -->
4545

46+
<section class="notes">
47+
48+
## Notes
49+
50+
- The 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.
51+
52+
</section>
53+
54+
<!-- /.notes -->
55+
4656
<section class="examples">
4757

4858
## Examples

lib/node_modules/@stdlib/constants/time/hours-in-day/docs/repl.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
{{alias}}
33
Number of hours in a day.
44

5+
The value is a generalization and does **not** take into account
6+
inaccuracies due to daylight savings conventions, crossing timezones, or
7+
other complications with time and dates.
8+
59
Examples
610
--------
711
> var days = 3.14;

lib/node_modules/@stdlib/constants/time/hours-in-week/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,16 @@ var bool = ( HOURS_IN_WEEK === 168 );
4343

4444
<!-- /.usage -->
4545

46+
<section class="notes">
47+
48+
## Notes
49+
50+
- The 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.
51+
52+
</section>
53+
54+
<!-- /.notes -->
55+
4656
<section class="examples">
4757

4858
## Examples

lib/node_modules/@stdlib/constants/time/hours-in-week/docs/repl.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
{{alias}}
33
Number of hours in a week.
44

5+
The value is a generalization and does **not** take into account
6+
inaccuracies due to daylight savings conventions, crossing timezones, or
7+
other complications with time and dates.
8+
59
Examples
610
--------
711
> var wkrs = 3.14;

lib/node_modules/@stdlib/constants/time/milliseconds-in-day/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,16 @@ var bool = ( MILLISECONDS_IN_DAY === 86400000 );
4343

4444
<!-- /.usage -->
4545

46+
<section class="notes">
47+
48+
## Notes
49+
50+
- The 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.
51+
52+
</section>
53+
54+
<!-- /.notes -->
55+
4656
<section class="examples">
4757

4858
## Examples

lib/node_modules/@stdlib/constants/time/milliseconds-in-day/docs/repl.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
{{alias}}
33
Number of milliseconds in a day.
44

5+
The value is a generalization and does **not** take into account
6+
inaccuracies due to daylight savings conventions, crossing timezones, or
7+
other complications with time and dates.
8+
59
Examples
610
--------
711
> var days = 3.14;

lib/node_modules/@stdlib/constants/time/milliseconds-in-hour/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,16 @@ var bool = ( MILLISECONDS_IN_HOUR === 3600000 );
4343

4444
<!-- /.usage -->
4545

46+
<section class="notes">
47+
48+
## Notes
49+
50+
- The 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.
51+
52+
</section>
53+
54+
<!-- /.notes -->
55+
4656
<section class="examples">
4757

4858
## Examples

lib/node_modules/@stdlib/constants/time/milliseconds-in-hour/docs/repl.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
{{alias}}
33
Number of milliseconds in an hour.
44

5+
The value is a generalization and does **not** take into account
6+
inaccuracies due to daylight savings conventions, crossing timezones, or
7+
other complications with time and dates.
8+
59
Examples
610
--------
711
> var hrs = 3.14;

lib/node_modules/@stdlib/constants/time/milliseconds-in-minute/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,16 @@ var bool = ( MILLISECONDS_IN_MINUTE === 60000 );
4343

4444
<!-- /.usage -->
4545

46+
<section class="notes">
47+
48+
## Notes
49+
50+
- The value is a generalization and does **not** take into account inaccuracies arising due to complications with time and dates.
51+
52+
</section>
53+
54+
<!-- /.notes -->
55+
4656
<section class="examples">
4757

4858
## Examples

lib/node_modules/@stdlib/constants/time/milliseconds-in-minute/docs/repl.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
{{alias}}
33
Number of milliseconds in a minute.
44

5+
The value is a generalization and does **not** take into account
6+
inaccuracies arising due to complications with time and dates.
7+
58
Examples
69
--------
710
> var mins = 3.14;

0 commit comments

Comments
 (0)