From 2efb5c44b8629348eccb144bcf05396a3de69f8f Mon Sep 17 00:00:00 2001
From: Jeremy Fee <jmfee@usgs.gov>
Date: Tue, 9 Dec 2014 19:12:31 -0700
Subject: [PATCH] Update put_timeseries api documentation
---
src/python/geomag/io/TimeseriesFactory.py | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/src/python/geomag/io/TimeseriesFactory.py b/src/python/geomag/io/TimeseriesFactory.py
index 24aecf1b..99910e16 100644
--- a/src/python/geomag/io/TimeseriesFactory.py
+++ b/src/python/geomag/io/TimeseriesFactory.py
@@ -41,6 +41,19 @@ class TimeseriesFactory(object):
"""
raise NotImplementedError('"get_timeseries" not implemented')
- def put_timeseries(self, timeseries):
- """Store timeseries data."""
+ def put_timeseries(self, timeseries, channels):
+ """Store timeseries data.
+
+ Parameters
+ ----------
+ timeseries : obspy.core.Stream
+ stream containing traces to store.
+ channels : list
+ list of channels to store.
+
+ Raises
+ ------
+ TimeseriesFactoryException
+ if any errors occur.
+ """
raise NotImplementedError('"put_timeseries" not implemented')
--
GitLab