Skip to content

Commit 130846f

Browse files
committed
Call out breaking changes in the documentation
1 parent 25316fe commit 130846f

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

CHANGES.rst

+6
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ This release cleans up a lot of older code and makes some small modifications to
88
Pythonic. 0.6.0 includes support for humanizing a `Delorean` object, as well as outputing a localized string
99
representing the `Delorean` object.
1010

11+
This change introduces the following breaking changes:
12+
- `Delorean.epoch` is a property, not a function.
13+
- `Delorean.midnight` is a property, not a function.
14+
- `Delorean.naive` is a property, not a function.
15+
- `Delorean.timezone` is a property, not a function.
16+
1117
- delorean/dates.py
1218
- `is_datetime_naive()` no longer returns True when dt is None
1319
- `localize()` works with pytz tzinfo objects

docs/index.rst

+10
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ Delorean stands on the shoulders of giants `pytz <http://pytz.sourceforge.net/>`
2222

2323
Pretty much make you a badass, time traveller.
2424

25+
Interface Update
26+
^^^^^^^^^^^^^^^^
27+
Version 0.6.0 introduces the following breaking changes:
28+
- `Delorean.epoch` is a property, not a function.
29+
- `Delorean.midnight` is a property, not a function.
30+
- `Delorean.naive` is a property, not a function.
31+
- `Delorean.timezone` is a property, not a function.
32+
33+
Please make sure to update your code accordingly.
34+
2535
Getting Started
2636
^^^^^^^^^^^^^^^
2737

0 commit comments

Comments
 (0)