Bump version and add changes to docs.

CHANGES.md

@@ -1,4 +1,6 @@
 ## Current
+
+## 0.4.2
 * Add seed-ids to the _spike_test's message.
 * utils.correlation
   - Cross-correlation normalisation errors no-longer raise an error

eqcorrscan/__init__.py

@@ -25,7 +25,7 @@
 
 __all__ = ['core', 'utils', 'tutorials', 'tests']
 
-__version__ = '0.4.1'
+__version__ = '0.4.2'
 
 # Cope with changes to name-space to remove most of the camel-case
 _import_map = {}

eqcorrscan/doc/updates.rst

@@ -1,6 +1,41 @@
 What's new
 ==========
 
+Version 0.4.2
+-------------
+* Add seed-ids to the _spike_test's message.
+* utils.correlation
+  - Cross-correlation normalisation errors no-longer raise an error
+  - When "out-of-range" correlations occur a warning is given by the C-function
+    with details of what channel, what template and where in the data vector
+    the issue occurred for the user to check their data.
+  - Out-of-range correlations are set to 0.0
+  - After extensive testing these errors have always been related to data issues
+    within regions where correlations should not be computed (spikes, step
+    artifacts due to incorrectly padding data gaps).
+  - USERS SHOULD BE CAREFUL TO CHECK THEIR DATA IF THEY SEE THESE WARNINGS
+* utils.mag_calc.amp_pick_event
+  - Added option to output IASPEI standard amplitudes, with static amplification
+    of 1 (rather than 2080 as per Wood Anderson specs).
+  - Added `filter_id` and `method_id` to amplitudes to make these methods more
+    traceable.
+* core.match_filter
+  - Bug-fix - cope with data that are too short with `ignore_bad_data=True`.
+    This flag is generally not advised, but when used, may attempt to trim all
+    data to zero length.  The expected behaviour is to remove bad data and run
+    with the remaining data.
+  - Party:
+    - decluster now accepts a hypocentral_separation argument. This allows
+      the inclusion of detections that occur close in time, but not in space.
+      This is underwritten by a new findpeaks.decluster_dist_time function
+      based on a new C-function.
+  - Tribe:
+    - Add monkey-patching for clients that do not have a `get_waveforms_bulk`
+      method for use in `.client_detect`. See issue #394.
+* utils.pre_processing
+  - Only templates that need to be reshaped are reshaped now - this can be a lot
+    faster.
+
 Version 0.4.1
 -------------
 * core.match_filter