update content

JuliaTime · Aug 13, 2024 · 2d16645 · 2d16645
1 parent 0ad3238
commit 2d16645
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 9 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,3 +1,2 @@
 {
-    "julia.environmentPath": "c:\\github\\Time\\NanoDates.jl"
 }
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -20,6 +20,9 @@
  - uses DateFormat
    - one 's' for each subsecond digit
    - `format(::NanoDate, ::DateFormat)`
+   - Technical Note: DateFormats used with NanoDates must use '.' only to separate seconds from subseconds.
+     - If you need that sort of format, use `NanoDate(DateTime(datestring, dateformat))`.
+     - `nd = NanoDate(DateTime("12.31.2024 23:59", dateformat"mm.dd.yyyy HH:MM"))`
 
 
 ----

diff --git a/docs/src/use/timestamps.md b/docs/src/use/timestamps.md
@@ -56,14 +56,20 @@
 | `2022-05-24T10:43:22.350_789`          | timestamp(floor(nd, Microsecond); sep=`_`) |
 | `2022-05-24T10:43:22.350⬩789⬩123`      | timestamp(nd; sep="⬩")                     |
 
-#### timestamps that are counts offset from the UNIX Epoch (1970-01-01 UTC)
+#### Offsets from the UNIX Epoch (1970-01-01 UTC)
 
-|               timestamp                | resolution  | method(nd::NanoDate)                |
-|:---------------------------------------|:------------|:------------------------------------|
-| `63789100018`                          | second      | nanodate2unixseconds(nd)            |
-| `63789100018123`                       | millisecond | nanodate2unixmillis(nd)             |
-| `63789100018123456`                    | microsecond | nanodate2unixmicros(nd)             |
+|   NanoDate                      | integer offset      | resolution  | method(nd::NanoDate)     |
+|:--------------------------------|---------------------|:------------|--------------------------|
+| "2022-05-24T10:43:22"           | 1653389002          | second      | nanodate2unixseconds(nd) |
+| "2022-05-24T10:43:22.123"       | 1653389002123       | millisecond | nanodate2unixmillis(nd)  |
+| "2022-05-24T10:43:22.123456"    | 1653389002123456    | microsecond | nanodate2unixmicros(nd)  |
+| "2022-05-24T10:43:22.123456789" | 1653389002123456789 | nanosecond  | nanodate2unixnanos(nd)   |
+
+| method(nd::NanoDate)     | inverse method                          |
+|--------------------------|-----------------------------------------|
+| nanodate2unixseconds(nd) | unixseconds2nanodate(integer secs)      |
+| nanodate2unixmillis(nd)  | unixmillis2nanodate(integer millisecs)  |
+| nanodate2unixmicros(nd)  | unixmicros2nanodate(integer microsecs)  |
+| nanodate2unixnanos(nd)   | unixnanos2nanodate(integer nanosecs)    |
 
-----
 
-##### *to request another timestamp format, please raise an issue [here](https://github.com/JuliaTime/NanoDates.jl/issues)*