Skip to content

Commit 67d616a

Browse files
committed
Updating NonFixedTarget docstring
1 parent 2f6523e commit 67d616a

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
@@ -1521,7 +1521,11 @@ class NonFixedTarget(Target):
15211521
"""
15221522
An object that is not "fixed" with respect to the celestial sphere.
15231523
1524-
Currently only some celestial objects are supported in this class.
1524+
A NonFixedTarget object holds a function that computes the coordinates
1525+
of the object at various points in time.
1526+
1527+
NonFixedTarget objects can at present be initialized only by the
1528+
``NonFixedTarget.from_name`` class method.
15251529
"""
15261530
def __init__(self, coord_function=None, name=None, constant_kwargs=None):
15271531
"""
@@ -1536,21 +1540,33 @@ def from_function(cls, coord_function, name=None):
15361540
"""
15371541
Initialize a `~astropy.NonFixedTarget` by passing in a function that
15381542
computes a `~astropy.coordinates.SkyCoord` for the target object.
1543+
1544+
Parameters
1545+
----------
1546+
coord_function : function
1547+
This function takes some input parameters and outputs a
1548+
`~astropy.coordinates.SkyCoord` for the object at one instance
1549+
in time
1550+
1551+
name : str (optional)
1552+
Name of the object
15391553
"""
15401554
return cls(coord_function=coord_function, name=name)
15411555

15421556
def at(self, *args, **kwargs):
15431557
"""
1544-
Get `~astropy.coordinates.SkyCoord` for the `~astroplan.NonFixedTarget`
1545-
at a given time, location, etc.
1558+
Get a `~astropy.coordinates.SkyCoord` object for the
1559+
`~astroplan.NonFixedTarget` at a given time, and/or other parameters.
15461560
15471561
Parameters
15481562
----------
1549-
All parameters passed to ``coord_function``.
1563+
All arguments and keyword arguments passed to already-specified
1564+
``self.coord_function``.
15501565
15511566
Returns
15521567
-------
1553-
A `~astropy.coordinates.SkyCoord` object as specified by the parameters.
1568+
`~astropy.coordinates.SkyCoord`
1569+
Specified by passing the arguments to ``self.coord_function``.
15541570
"""
15551571
if self.constant_kwargs is not None:
15561572
for key in self.constant_kwargs:

0 commit comments

Comments
 (0)