From 78ce7e91f7466e7c3c86ca306dd4ed1ba3bac403 Mon Sep 17 00:00:00 2001 From: teutoburg Date: Wed, 27 Nov 2024 14:36:38 +0100 Subject: [PATCH] Add more module docstrings for API reference --- scopesim_templates/extragalactic/agns.py | 2 ++ scopesim_templates/extragalactic/clusters.py | 2 ++ scopesim_templates/extragalactic/exgal_models.py | 3 ++- scopesim_templates/extragalactic/galaxies.py | 3 ++- scopesim_templates/extragalactic/galaxy_utils.py | 3 +++ scopesim_templates/extragalactic/quasars.py | 2 ++ scopesim_templates/stellar/clusters.py | 1 + scopesim_templates/stellar/imf.py | 3 ++- scopesim_templates/stellar/stars.py | 3 +++ scopesim_templates/stellar/stars_utils.py | 3 +++ 10 files changed, 22 insertions(+), 3 deletions(-) diff --git a/scopesim_templates/extragalactic/agns.py b/scopesim_templates/extragalactic/agns.py index e69de29..921a401 100644 --- a/scopesim_templates/extragalactic/agns.py +++ b/scopesim_templates/extragalactic/agns.py @@ -0,0 +1,2 @@ +# -*- coding: utf-8 -*- +"""Placeolder, currently empty.""" diff --git a/scopesim_templates/extragalactic/clusters.py b/scopesim_templates/extragalactic/clusters.py index e69de29..921a401 100644 --- a/scopesim_templates/extragalactic/clusters.py +++ b/scopesim_templates/extragalactic/clusters.py @@ -0,0 +1,2 @@ +# -*- coding: utf-8 -*- +"""Placeolder, currently empty.""" diff --git a/scopesim_templates/extragalactic/exgal_models.py b/scopesim_templates/extragalactic/exgal_models.py index 35e1f15..547b076 100644 --- a/scopesim_templates/extragalactic/exgal_models.py +++ b/scopesim_templates/extragalactic/exgal_models.py @@ -1,4 +1,5 @@ -"""Module should contain analytical extragalactic models.""" +# -*- coding: utf-8 -*- +"""Contains abstract models used by the galaxy functions.""" from dataclasses import dataclass from collections.abc import Generator diff --git a/scopesim_templates/extragalactic/galaxies.py b/scopesim_templates/extragalactic/galaxies.py index 1d6476d..82517dd 100644 --- a/scopesim_templates/extragalactic/galaxies.py +++ b/scopesim_templates/extragalactic/galaxies.py @@ -1,5 +1,6 @@ # -*- coding: utf-8 -*- -"""TBA.""" +"""Contains several functions for simple galaxy models.""" + import pathlib import numpy as np diff --git a/scopesim_templates/extragalactic/galaxy_utils.py b/scopesim_templates/extragalactic/galaxy_utils.py index c7d8941..9507323 100644 --- a/scopesim_templates/extragalactic/galaxy_utils.py +++ b/scopesim_templates/extragalactic/galaxy_utils.py @@ -1,3 +1,6 @@ +# -*- coding: utf-8 -*- +"""Contains an alternative function for Sersic profiles.""" + import numpy as np from astropy.modeling.models import Sersic2D diff --git a/scopesim_templates/extragalactic/quasars.py b/scopesim_templates/extragalactic/quasars.py index e69de29..921a401 100644 --- a/scopesim_templates/extragalactic/quasars.py +++ b/scopesim_templates/extragalactic/quasars.py @@ -0,0 +1,2 @@ +# -*- coding: utf-8 -*- +"""Placeolder, currently empty.""" diff --git a/scopesim_templates/stellar/clusters.py b/scopesim_templates/stellar/clusters.py index c7c7b1d..62d9e2c 100644 --- a/scopesim_templates/stellar/clusters.py +++ b/scopesim_templates/stellar/clusters.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """Currently only contains a simple zero-age open cluster.""" import numpy as np diff --git a/scopesim_templates/stellar/imf.py b/scopesim_templates/stellar/imf.py index a7e2971..a51469a 100644 --- a/scopesim_templates/stellar/imf.py +++ b/scopesim_templates/stellar/imf.py @@ -1,5 +1,6 @@ +# -*- coding: utf-8 -*- """ -Initial mass function. +Initial mass function, used by the cluster function. KL: Copied (18.06.2020, vers:134c5ff) almost directly from diff --git a/scopesim_templates/stellar/stars.py b/scopesim_templates/stellar/stars.py index 48ac56b..b5e04ec 100644 --- a/scopesim_templates/stellar/stars.py +++ b/scopesim_templates/stellar/stars.py @@ -1,3 +1,6 @@ +# -*- coding: utf-8 -*- +"""Contains functions to create random or regular spaced point sources.""" + import numpy as np from astropy.table import Table from astropy import units as u diff --git a/scopesim_templates/stellar/stars_utils.py b/scopesim_templates/stellar/stars_utils.py index 7c7f31b..7504f37 100644 --- a/scopesim_templates/stellar/stars_utils.py +++ b/scopesim_templates/stellar/stars_utils.py @@ -1,3 +1,6 @@ +# -*- coding: utf-8 -*- +"""Internal utility functions for stellar functions.""" + import numpy as np from collections.abc import Iterable