Skip to content

Commit 1cb4468

Browse files
committed
Updating NonFixedTarget docstring
1 parent 5d88cdf commit 1cb4468

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

astroplan/core.py

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1809,7 +1809,11 @@ class NonFixedTarget(Target):
18091809
"""
18101810
An object that is not "fixed" with respect to the celestial sphere.
18111811
1812-
Currently only some celestial objects are supported in this class.
1812+
A NonFixedTarget object holds a function that computes the coordinates
1813+
of the object at various points in time.
1814+
1815+
NonFixedTarget objects can at present be initialized only by the
1816+
``NonFixedTarget.from_name`` class method.
18131817
"""
18141818
def __init__(self, coord_function=None, name=None, constant_kwargs=None):
18151819
"""
@@ -1824,21 +1828,33 @@ def from_function(cls, coord_function, name=None):
18241828
"""
18251829
Initialize a `~astropy.NonFixedTarget` by passing in a function that
18261830
computes a `~astropy.coordinates.SkyCoord` for the target object.
1831+
1832+
Parameters
1833+
----------
1834+
coord_function : function
1835+
This function takes some input parameters and outputs a
1836+
`~astropy.coordinates.SkyCoord` for the object at one instance
1837+
in time
1838+
1839+
name : str (optional)
1840+
Name of the object
18271841
"""
18281842
return cls(coord_function=coord_function, name=name)
18291843

18301844
def at(self, *args, **kwargs):
18311845
"""
1832-
Get `~astropy.coordinates.SkyCoord` for the `~astroplan.NonFixedTarget`
1833-
at a given time, location, etc.
1846+
Get a `~astropy.coordinates.SkyCoord` object for the
1847+
`~astroplan.NonFixedTarget` at a given time, and/or other parameters.
18341848
18351849
Parameters
18361850
----------
1837-
All parameters passed to ``coord_function``.
1851+
All arguments and keyword arguments passed to already-specified
1852+
``self.coord_function``.
18381853
18391854
Returns
18401855
-------
1841-
A `~astropy.coordinates.SkyCoord` object as specified by the parameters.
1856+
`~astropy.coordinates.SkyCoord`
1857+
Specified by passing the arguments to ``self.coord_function``.
18421858
"""
18431859
if self.constant_kwargs is not None:
18441860
for key in self.constant_kwargs:

0 commit comments

Comments
 (0)