Skip to content

Commit 2ef2bfd

Browse files
committed
Flesh out the datetime module docs a bit.
1 parent 521d8ab commit 2ef2bfd

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/datetime.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
//! Support datetimes and timedeltas
22
//!
3+
//! This module provides wrappers for NumPy's [`datetime64`][scalars-datetime64] and [`timedelta64`][scalars-timedelta64] types
4+
//! which are used for time keeping with with an emphasis on scientific applications.
5+
//! This means that while these types differentiate absolute and relative quantities, they ignore calendars (a month is always 30.44 days) and time zones.
6+
//! On the other hand, their flexible units enable them to support either a large range (up to 2<sup>64</sup> years) or high precision (down to 10<sup>-18</sup> seconds).
7+
//!
38
//! [The corresponding section][datetime] of the NumPy documentation contains more information.
49
//!
510
//! # Example
@@ -49,6 +54,8 @@
4954
//! ```
5055
//!
5156
//! [datetime]: https://numpy.org/doc/stable/reference/arrays.datetime.html
57+
//! [scalars-datetime64]: https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.datetime64
58+
//! [scalars-timedelta64]: https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.timedelta64
5259
5360
use std::cell::UnsafeCell;
5461
use std::collections::hash_map::Entry;

0 commit comments

Comments
 (0)