Skip to content

Commit 606db7c

Browse files
committed
Document core.NAIVE.
1 parent 5019b5f commit 606db7c

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

doc/api/core.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Core
88
of the :mod:`github2` package, but it is documented to aid contributors
99
to the package.
1010

11+
.. autodata:: NAIVE(bool)
12+
13+
Set to ``False`` for timezone-aware :class:`datetime.datetime` objects
14+
1115
.. autofunction:: ghdate_to_datetime
1216
.. autofunction:: datetime_to_ghdate
1317

github2/core.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
COMMIT_DATE_FORMAT = "%Y-%m-%dT%H:%M:%S"
1414
GITHUB_TZ = tz.gettz("America/Los_Angeles")
1515

16-
# Operate on naive datetime objects, this is the default for backwards
17-
# compatibility
16+
#: Operate on naive :class:`datetime.datetime` objects, this is the default
17+
#: for backwards compatibility
1818
NAIVE = True
1919

2020

0 commit comments

Comments
 (0)