Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix some documentation bugs #2514

Merged
merged 8 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api-reference/atmosphere/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ Reference/API
=============

.. automodapi:: ctapipe.atmosphere
:inherited-members:
2 changes: 1 addition & 1 deletion src/ctapipe/atmosphere.py
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ class FiveLayerAtmosphereDensityProfile(AtmosphereDensityProfile):

Layer 5 is modeled with:

..math:: T(h) = a_5 - b_5 \frac{h}{c_5}
.. math:: T(h) = a_5 - b_5 \frac{h}{c_5}

References
----------
Expand Down
9 changes: 0 additions & 9 deletions src/ctapipe/coordinates/ground_frames.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@
this different systems. Frames and transformations are defined using
the astropy.coordinates framework. This module defines transformations
for ground based cartesian and planar systems.

For examples on usage see examples/coordinate_transformations.py

This code is based on the coordinate transformations performed in the
read_hess code

TODO:

- Tests Tests Tests!
"""
import astropy.units as u
import numpy as np
Expand Down
6 changes: 3 additions & 3 deletions src/ctapipe/coordinates/nominal_frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ class NominalFrame(BaseCoordinateFrame):
Attributes
----------

origin: SkyCoord[AltAz]
origin: astropy.coordinates.SkyCoord[AltAz]
Origin of this frame as a HorizonCoordinate
obstime: Tiem
obstime: astropy.time.Time
Observation time
location: EarthLocation
location: astropy.coordinates.EarthLocation
Location of the telescope
"""

Expand Down
4 changes: 2 additions & 2 deletions src/ctapipe/core/telescope_component.py
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ class TelescopeParameter(List):
Examples
--------

.. code-block: python
.. code-block:: python

tel_param = [
('type', '*', 5.0), # default for all
Expand All @@ -280,7 +280,7 @@ class TelescopeParameter(List):
('id', 34, 4.0), # override telescope 34 specifically
]

.. code-block: python
.. code-block:: python

tel_param = 4.0 # sets this value for all telescopes

Expand Down
Loading