Skip to content

Commit 804a2c2

Browse files
Added doc strings to the new public methods
1 parent 78c2f36 commit 804a2c2

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

astroquery/esa/hubble/core.py

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ def download_product(self, observation_id, *, calibration_level=None,
121121

122122
def get_member_observations(self, observation_id):
123123
"""
124+
Returns the related members of simple and composite observations
125+
124126
Parameters
125127
----------
126128
observation_id : str, mandatory
@@ -129,8 +131,7 @@ def get_member_observations(self, observation_id):
129131
Returns
130132
-------
131133
A list of strings with the observation_id of the associated
132-
observations that can be used in get_product_list and
133-
get_obs_products functions
134+
observations
134135
"""
135136
if observation_id is None:
136137
raise ValueError(self.REQUESTED_OBSERVATION_ID)
@@ -145,6 +146,21 @@ def get_member_observations(self, observation_id):
145146
return oids
146147

147148
def get_hap_hst_link(self, observation_id):
149+
"""
150+
Returns the related members of hap and hst observations
151+
152+
Parameters
153+
----------
154+
observation_id : string
155+
id of the observation to be downloaded, mandatory
156+
The identifier of the observation we want to retrieve, regardless
157+
of whether it is simple or composite.
158+
159+
Returns
160+
-------
161+
A list of strings with the observation_id of the associated
162+
observations
163+
"""
148164
if observation_id is None:
149165
raise ValueError(self.REQUESTED_OBSERVATION_ID)
150166
observation_type = self.get_observation_type(observation_id)
@@ -161,6 +177,20 @@ def get_hap_hst_link(self, observation_id):
161177
return oids
162178

163179
def get_observation_type(self, observation_id):
180+
"""
181+
Returns the type of an observation
182+
183+
Parameters
184+
----------
185+
observation_id : string
186+
id of the observation to be downloaded, mandatory
187+
The identifier of the observation we want to retrieve, regardless
188+
of whether it is simple or composite.
189+
190+
Returns
191+
-------
192+
String with the observation type
193+
"""
164194
if observation_id is None:
165195
raise ValueError(self.REQUESTED_OBSERVATION_ID)
166196

0 commit comments

Comments
 (0)