Add more module docstrings for API reference (#114)

AstarVienna · Nov 27, 2024 · 2590e48 · 2590e48
2 parents 541b70f + 78ce7e9
commit 2590e48
Show file tree

Hide file tree

Showing 10 changed files with 22 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+"""Placeolder, currently empty."""
diff --git 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
@@ -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
@@ -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
@@ -1,3 +1,6 @@
+# -*- coding: utf-8 -*-
+"""Internal utility functions for stellar functions."""
+
 import numpy as np
 from collections.abc import Iterable
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# -- coding: utf-8 --
		"""Placeolder, currently empty."""