Call out breaking changes in the documentation

myusuf3 · Dec 9, 2015 · 130846f · 130846f
1 parent 25316fe
commit 130846f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -8,6 +8,12 @@ This release cleans up a lot of older code and makes some small modifications to
 Pythonic. 0.6.0 includes support for humanizing a `Delorean` object, as well as outputing a localized string
 representing the `Delorean` object.
 
+This change introduces the following breaking changes:
+    - `Delorean.epoch` is a property, not a function.
+    - `Delorean.midnight` is a property, not a function.
+    - `Delorean.naive` is a property, not a function.
+    - `Delorean.timezone` is a property, not a function.
+
 - delorean/dates.py
     - `is_datetime_naive()` no longer returns True when dt is None
     - `localize()` works with pytz tzinfo objects

diff --git a/docs/index.rst b/docs/index.rst
@@ -22,6 +22,16 @@ Delorean stands on the shoulders of giants `pytz <http://pytz.sourceforge.net/>`
 
 Pretty much make you a badass, time traveller.
 
+Interface Update
+^^^^^^^^^^^^^^^^
+Version 0.6.0 introduces the following breaking changes:
+    - `Delorean.epoch` is a property, not a function.
+    - `Delorean.midnight` is a property, not a function.
+    - `Delorean.naive` is a property, not a function.
+    - `Delorean.timezone` is a property, not a function.
+
+Please make sure to update your code accordingly.
+
 Getting Started
 ^^^^^^^^^^^^^^^