Skip to content

Commit

Permalink
DOC: include kwargs
Browse files Browse the repository at this point in the history
  • Loading branch information
andykee committed May 7, 2024
1 parent 16424fd commit 81574d8
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions lentil/plane.py
Original file line number Diff line number Diff line change
Expand Up @@ -634,9 +634,6 @@ class Image(Plane):
Binary mask. If not specified, a mask is created from the amplitude.
pixelscale : float, optional
Pixel size in meters. Pixels are assumed to be square. Default is None.
Other Parameters
----------------
**kwargs : :class:`Plane` parameters
Keyword arguments passed to :class:`~lentil.Plane` constructor
Expand Down Expand Up @@ -670,8 +667,8 @@ class TiltInterface(Plane):
"""Utility class for holding common lofic shared by classes that need to
implement the tilt interface.
Other Parameters
----------------
Parameters
----------
**kwargs : :class:`~lentil.Plane` parameters
Keyword arguments passed to :class:`~lentil.Plane` constructor
Expand Down Expand Up @@ -733,6 +730,8 @@ class Tilt(TiltInterface):
Radians of tilt about the x-axis
y : float
Radians of tilt about the y-axis
**kwargs : :class:`Plane` parameters
Keyword arguments passed to :class:`~lentil.Plane` constructor
"""
def __init__(self, x, y, **kwargs):
Expand Down Expand Up @@ -781,6 +780,8 @@ class DispersiveTilt(TiltInterface):
Polynomial coefficients describing the dispersion in decreasing powers
(i.e. dispersion[0] represents the highest order coefficient and
dispersion[-1] represents the lowest.)
**kwargs : :class:`Plane` parameters
Keyword arguments passed to :class:`~lentil.Plane` constructor
Notes
-----
Expand Down Expand Up @@ -994,6 +995,8 @@ class Grism(DispersiveTilt):
Polynomial coefficients describing the dispersion produced by the grism
in decreasing powers (i.e. dispersion[0] represents the highest order
coefficient and dispersion[-1] represents the lowest.)
**kwargs : :class:`Plane` parameters
Keyword arguments passed to :class:`~lentil.Plane` constructor
.. deprecated:: 1.0.0
`Grism` will be removed in Lentil v1.0.0, it is replaced by
Expand Down

0 comments on commit 81574d8

Please sign in to comment.