Skip to content

Commit

Permalink
improve docstring of get_surveys, no default
Browse files Browse the repository at this point in the history
  • Loading branch information
ismael-mendoza committed Mar 23, 2022
1 parent ea49936 commit 07e19bd
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions btk/survey.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
"""Contains information for surveys available in BTK."""
import os
import random as rd
from collections.abc import Callable
from typing import Callable, Union, List

import astropy.wcs as WCS
import galcheat
import galsim
import numpy as np
from astropy.io import fits

from galcheat.survey import Survey

def get_surveys(names="LSST", psf_func: Callable = None):

def get_surveys(names: Union[Survey, List[Survey]], psf_func: Callable = None):
"""Return specified surveys from galcheat extended to contain PSF information.
This function currently returns a list of galcheat instances if `names` is a list with more
than one element. If `names` is a str or a singleton list then we return a single galcheat
instance.
Args:
names (str or list): A single str specifying a survey from conf/surveys or a list with
multiple survey names.
Expand Down

0 comments on commit 07e19bd

Please sign in to comment.