Add version info in various docstrings (#678)

Author: teutoburg

scopesim/effects/binning_3d.py

@@ -14,7 +14,11 @@
 
 
 class FluxBinning3D(Effect):
-    """Takes care of cube flux conversion in absence of a SpectralTraceList."""
+    """Takes care of cube flux conversion in absence of a SpectralTraceList.
+
+    .. versionadded:: PLACEHOLDER_NEXT_RELEASE_VERSION
+
+    """
 
     z_order: ClassVar[tuple[int, ...]] = (690,)
 

scopesim/effects/electronic/electrons.py

@@ -124,6 +124,10 @@ class ADConversion(Effect):
     Again, `!DET.gain` can be used here. This can be useful when the
     `DetectorModePropertiesSetter` effect is used to switch between different
     detector modes with different gain values.
+
+    .. versionchanged:: PLACEHOLDER_NEXT_RELEASE_VERSION
+
+       Renamed from `Quantization` to `ADConversion`.
     """
 
     z_order: ClassVar[tuple[int, ...]] = (825,)

scopesim/effects/electronic/exposure.py

@@ -186,7 +186,11 @@ def apply_to(self, obj, **kwargs):
 
 
 class ExposureOutput(Effect):
-    """Return average or sum of ``ndit`` subexposures."""
+    """Return average or sum of ``ndit`` subexposures.
+
+    .. versionadded:: 0.9.3
+
+    """
 
     required_keys = {"dit", "ndit"}
     z_order: ClassVar[tuple[int, ...]] = (861,)

scopesim/effects/metis_ifu_simple/__init__.py

@@ -1,11 +1,13 @@
 # -*- coding: utf-8 -*-
-"""
-Effects for the METIS IFU_SMPL mode
+"""Effects for the METIS IFU_SMPL mode.
+
+.. versionadded:: PLACEHOLDER_NEXT_RELEASE_VERSION
 
 Classes:
 - LineSpreadFunction
 
 """
+
 from .ifu_simple import LineSpreadFunction
 from ...utils import get_logger
 

scopesim/effects/metis_ifu_simple/ifu_simple.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"""Effects for the METIS ifu_cube mode"""
+"""Effects for the METIS ifu_cube mode."""
 
 from typing import ClassVar
 
@@ -15,7 +15,7 @@
 
 class LineSpreadFunction(Effect):
     """
-    Compute and apply line spread function to IFU cube
+    Compute and apply line spread function to IFU cube.
 
     The effect can be instantiated either with the single parameter
 
@@ -39,7 +39,11 @@ class LineSpreadFunction(Effect):
          Spectral bin width of the 3D detector of the lms_cube mode.
 
     These values are set in `METIS_LMS_SMPL.yaml`.
+
+    .. versionadded:: PLACEHOLDER_NEXT_RELEASE_VERSION
+
     """
+
     z_order: ClassVar[tuple[int, ...]] = (660,)
     report_plot_include: ClassVar[bool] = True
     report_table_include: ClassVar[bool] = False
@@ -56,7 +60,7 @@ def __init__(self, **kwargs):
         self.kernel = self.get_kernel()
 
     def apply_to(self, obj, **kwargs):
-        """Apply the LSF"""
+        """Apply the LSF."""
         if not isinstance(obj, FieldOfView):
             return obj
 
@@ -69,8 +73,7 @@ def apply_to(self, obj, **kwargs):
         return obj
 
     def get_lsf_width(self):
-        """Determine width of the LSF kernel at central wavelength"""
-
+        """Determine width of the LSF kernel at central wavelength."""
         slope = self.meta['fit_slope']
         intercept = self.meta['fit_intercept']
         lamc = self.meta["wavelen"]
@@ -85,10 +88,8 @@ def get_lsf_width(self):
 
         return dlam_per_slice / spec_binwidth
 
-
     def get_kernel(self):
-        """Build LSF kernel: box kernel smoothed with narrow Gauss"""
-
+        """Build LSF kernel: box kernel smoothed with narrow Gauss."""
         box = Box1DKernel(width=self.lsfwidth)
         gauss = Gaussian1DKernel(1)
         if box.shape > gauss.shape:

scopesim/effects/metis_wcu/__init__.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-Effects for METIS Warm Calibration Unit
+Effects for METIS Warm Calibration Unit.
+
+.. versionadded:: 0.9.2
 
 Classes:
 - WCUSource

scopesim/effects/metis_wcu/fpmask.py

@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
-"""A class for the METIS WCU focal-plane mask."""
+"""A class for the METIS WCU focal-plane mask.
+
+.. versionadded:: 0.9.2
+
+"""
 
 from pathlib import Path
 
@@ -22,6 +26,8 @@ class FPMask:
     ----------
     See :class:`DataContainer` for input parameters
 
+    .. versionadded:: 0.9.2
+
     """
 
     hdr = {

scopesim/effects/metis_wcu/metis_wcu.py

@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
-"""Classes for the METIS Warm Calibration Unit."""
+"""Classes for the METIS Warm Calibration Unit.
+
+.. versionadded:: 0.9.2
+
+"""
 
 from typing import ClassVar
 
@@ -70,6 +74,9 @@ class WCUSource(TERCurve):
 
     Which laser is seen depends on the wavelength of the observation. Note that
     the tunable laser currently cannot be tuned.
+
+    .. versionadded:: 0.9.2
+
     """
 
     z_order: ClassVar[tuple[int, ...]] = (113, 513)

scopesim/effects/psfs/discrete.py

@@ -69,6 +69,11 @@ class FieldConstantPSF(DiscretePSF):
 
     For spectroscopy, a wavelength-dependent PSF cube is built, where for each
     wavelength the reference PSF is scaled proportional to wavelength.
+
+    .. versionchanged:: PLACEHOLDER_NEXT_RELEASE_VERSION
+       PSF interpolation can now be limited to the central wavelength by
+       setting the "!OBS.interp_psf" keyword to False.
+
     """
 
     required_keys = {"filename"}

scopesim/source/source.py

@@ -151,6 +151,11 @@ class Source:
     --------
     synphot : ``https://synphot.readthedocs.io/en/latest/``
 
+    .. versionchanged:: PLACEHOLDER_NEXT_RELEASE_VERSION
+
+       Added the ability to instantiate directly from an existing SourceField
+       subclass instance.
+
     """
 
     def __init__(self, filename=None, cube=None, ext=0,