From ac932c6e59ad80115962d0ea91e6aaabc70c211e Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sat, 3 Apr 2021 14:48:30 -0700 Subject: [PATCH] update timestamp docs --- docs/utils.md | 2 ++ jc/utils.py | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/utils.md b/docs/utils.md index b791be87..077f969c 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -77,9 +77,11 @@ timestamp(datetime_string) Input a date-time text string of several formats and convert to a naive or timezone-aware epoch timestamp in UTC Parameters: + datetime_string: (str) a string representation of a date-time in several supported formats Attributes: + string (str) the input datetime string format (int) the format rule that was used to decode the datetime string naive (int) timestamp based on locally configured timezone. None if conversion fails diff --git a/jc/utils.py b/jc/utils.py index 58874714..8284f4af 100644 --- a/jc/utils.py +++ b/jc/utils.py @@ -88,9 +88,11 @@ class timestamp: Input a date-time text string of several formats and convert to a naive or timezone-aware epoch timestamp in UTC Parameters: + datetime_string: (str) a string representation of a date-time in several supported formats Attributes: + string (str) the input datetime string format (int) the format rule that was used to decode the datetime string naive (int) timestamp based on locally configured timezone. None if conversion fails