1
0
Fork 0

scheduling/create_new_observation: Add verbose docstring

Signed-off-by: Fabian P. Schmidt <kerel@mailbox.org>
merge-requests/852/head
Fabian P. Schmidt 2019-12-31 17:44:40 +01:00 committed by Alfredos-Panagiotis Damkalis
parent 642a0a2c61
commit 6ed02d4dd9
1 changed files with 13 additions and 1 deletions

View File

@ -283,7 +283,19 @@ def predict_available_observation_windows(station, min_horizon, overlapped, tle,
def create_new_observation(station, transmitter, start, end, author):
"""Creates and returns a new Observation object"""
"""
Creates and returns a new Observation object
Arguments:
station - network.base.models.Station
transmitter - network.base.models.Transmitter
start - datetime
end - datetime
author - network.base.models.User
Returns network.base.models.Observation
Raises NegativeElevationError, ObservationOverlapError, SinglePassError or more
"""
scheduled_obs = Observation.objects.filter(ground_station=station).filter(end__gt=now())
window = resolve_overlaps(scheduled_obs, start, end)