Skip to content
Snippets Groups Projects
Commit 88d82e08 authored by Hal Simpson's avatar Hal Simpson
Browse files

Updated doc strings

parent 849a9291
No related branches found
No related tags found
No related merge requests found
...@@ -34,7 +34,9 @@ class EdgeFactory(TimeseriesFactory): ...@@ -34,7 +34,9 @@ class EdgeFactory(TimeseriesFactory):
observatory: str observatory: str
the observatory code for the desired observatory. the observatory code for the desired observatory.
channels: array channels: array
an array of channels {H, D, E, F, Z} an array of channels {H, D, E, F, Z, MGD, MSD, HGD}
any channel name will get passed through. H, D, E, F, Z
will be converted according to interval and type.
type: str type: str
the data type {variation, quasi-definitive, definitive} the data type {variation, quasi-definitive, definitive}
interval: str interval: str
...@@ -323,7 +325,8 @@ class EdgeFactory(TimeseriesFactory): ...@@ -323,7 +325,8 @@ class EdgeFactory(TimeseriesFactory):
observatory : str observatory : str
observatory code observatory code
channel : str channel : str
single character channel {H, E, D, Z, F} single character channel {H, E, D, Z, F, X, Y, G} or
any appropriate edge channel, ie MSD, MGD, HGD.
type : str type : str
data type {definitive, quasi-definitive, variation} data type {definitive, quasi-definitive, variation}
interval : str interval : str
...@@ -332,7 +335,7 @@ class EdgeFactory(TimeseriesFactory): ...@@ -332,7 +335,7 @@ class EdgeFactory(TimeseriesFactory):
Returns Returns
------- -------
edge_channel edge_channel
{MVH, MVE, MVD, etc} {MVH, MVE, MVD, MGD etc}
""" """
edge_interval_code = self._get_interval_code(interval) edge_interval_code = self._get_interval_code(interval)
edge_channel = None edge_channel = None
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment