Skip to content

Commit 4168db6

Browse files
author
Brett M. Morris
authored
Merge pull request #172 from bmorris3/fix-issue-102
Adding links to Read the Docs tutorials for plotting functions
2 parents cd423ca + 9f6acef commit 4168db6

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

astroplan/plots/sky.py

+7
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ def plot_sky(target, observer, time, ax=None, style_kwargs=None,
3131
(e.g. ``Time(['2000-1-1 20:00:00', '2000-1-1 20:30:00'])``), target's
3232
position will be shown at each of these times.
3333
34+
For examples with plots, visit the astroplan Read the Docs
35+
documentation [1]_.
36+
3437
Parameters
3538
----------
3639
target : `~astroplan.FixedTarget`
@@ -105,6 +108,10 @@ def plot_sky(target, observer, time, ax=None, style_kwargs=None,
105108
``az_label_offset`` option, but it is not recommended, as to do so
106109
makes it seem as if N/E/S/W are being decoupled from the definition
107110
of azimuth (North from az = 0 deg., East from az = 90 deg., etc.).
111+
112+
References
113+
----------
114+
.. [1] astroplan plotting tutorial: https://astroplan.readthedocs.io/en/latest/tutorials/plots.html#sky-charts
108115
"""
109116
# Import matplotlib, set style sheet
110117
if style_sheet is not None:

astroplan/plots/time_dependent.py

+13-4
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,9 @@ def plot_airmass(target, observer, time, ax=None, style_kwargs=None,
6464
object. For instance, ``Time(['2000-1-1 23:00:00', '2000-1-1
6565
23:30:00'])`` will result in a plot with only two airmass measurements.
6666
67+
For examples with plots, visit the astroplan Read the Docs
68+
documentation [1]_.
69+
6770
Parameters
6871
----------
6972
target : `~astroplan.FixedTarget`
@@ -112,8 +115,10 @@ def plot_airmass(target, observer, time, ax=None, style_kwargs=None,
112115
If user wishes to change these, use ``ax.\<set attribute\>`` before drawing
113116
or saving plot:
114117
115-
TODO:
116-
1) Timezones?
118+
References
119+
----------
120+
.. [1] astroplan plotting tutorial: https://astroplan.readthedocs.io/en/latest/tutorials/plots.html#time-dependent-plots
121+
117122
"""
118123
# Import matplotlib, set style sheet
119124
if style_sheet is not None:
@@ -221,6 +226,9 @@ def plot_parallactic(target, observer, time, ax=None, style_kwargs=None,
221226
object. For instance, ``Time(['2000-1-1 23:00:00', '2000-1-1 23:30:00'])``
222227
will result in a plot with only two parallactic angle measurements.
223228
229+
For examples with plots, visit the astroplan Read the Docs
230+
documentation [1]_.
231+
224232
Parameters
225233
----------
226234
target : `~astroplan.FixedTarget`
@@ -254,8 +262,9 @@ def plot_parallactic(target, observer, time, ax=None, style_kwargs=None,
254262
ax : `~matplotlib.axes.Axes`
255263
An ``Axes`` object with added parallactic angle vs. time plot.
256264
257-
TODO:
258-
1) observe_timezone -- update with info from observer?
265+
References
266+
----------
267+
.. [1] astroplan plotting tutorial: https://astroplan.readthedocs.io/en/latest/tutorials/plots.html#time-dependent-plots
259268
"""
260269
# Import matplotlib, set style sheet
261270
if style_sheet is not None:

0 commit comments

Comments
 (0)