From 4b7bb9a6961c631bc27724638b4788bd99b458f5 Mon Sep 17 00:00:00 2001
From: Jeremy Fee <jmfee@usgs.gov>
Date: Thu, 12 May 2016 16:17:22 -0600
Subject: [PATCH] Add comments about implementing parse_string/write_file
 methods

---
 geomagio/TimeseriesFactory.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/geomagio/TimeseriesFactory.py b/geomagio/TimeseriesFactory.py
index f631b90a..b97e99dc 100644
--- a/geomagio/TimeseriesFactory.py
+++ b/geomagio/TimeseriesFactory.py
@@ -9,6 +9,14 @@ import Util
 class TimeseriesFactory(object):
     """Base class for timeseries factories.
 
+    Add input support by:
+        - implementing `parse_string`
+        - or, overriding `get_timeseries`
+
+    Add output support by:
+        - implementing `write_file`
+        - or, overriding `put_timeseries`
+
     Attributes
     ----------
     observatory : str
-- 
GitLab