Skip to content

Commit

Permalink
fix(doc): Remove references to ch_ephem.observers.get (#5)
Browse files Browse the repository at this point in the history
While looking at this code in reference to
chime-experiment/ch_util#89
I realised the documentation here was referencing the non-existent
function `ch_ephem.observers.get`, which existed briefly during
development, before being replaced by the more intuitive way it works
now where users can just import the observer they want directly from
the module.
  • Loading branch information
ketiltrout authored Dec 17, 2024
1 parent 8bb06a4 commit 6185fdf
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
7 changes: 3 additions & 4 deletions ch_ephem/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@
Any ephemeris routine which needs to know the location of the
observer on the Earth are accessible via instrument Observer
instances obtainable through :py:meth:`ch_ephem.observers.get`:
instances importable from :py:meth:`ch_ephem.observers`:
>>> import ch_ephem.observers
>>> pathfinder = ch_ephem.observers.get("pathfinder")
>>> from ch_ephem.observers import pathfinder
>>> pathfinder.solar_transit(...)
The `Observer` instances returned by this method are subclassed from
The `Observer` instances provided by this module are subclassed from
`caput.time.Observers` and can be used as normal `caput` observers.
Location and geometry data for the instrument observers are defined
in the data file `instruments.yaml` provided as part of `ch_ephem`.
Expand Down
4 changes: 2 additions & 2 deletions ch_ephem/observers.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
`caput.time.Observer` to additionally provide rotation, roll and tangent-space
offset for the instruments:
>>> pathfinder = ch_ephem.observers.get("pathfinder")
>>> from ch_ephem.observers import pathfinder
>>> print(pathfinder.rotation)
1.986
>>> print(pathfinder.roll)
Expand Down Expand Up @@ -173,7 +173,7 @@ def __getattr__(name: str) -> Observer:
Raises
------
ValueError:
AttributeError:
Data for the instrument named could not be found.
"""

Expand Down

0 comments on commit 6185fdf

Please sign in to comment.