Skip to content

Commit

Permalink
Improve documentation per review comment
Browse files Browse the repository at this point in the history
  • Loading branch information
taldcroft committed Jan 18, 2024
1 parent 6cfeaf4 commit 7f875f1
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions kadi/commands/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,16 @@ def read_backstop(
calls to ``get_observations`` and ``get_starcats``.
If ``load_name`` is provided then this is used for the "source" column in the
returned table. If not provided, the default is to use the load name if it can be
determined from the backstop directory path (e.g. "DEC1123A" from
"<rootdir>/2023/DEC1123/oflsa/CR344_2303.backstop"), otherwise it is set to "None".
returned table.
If ``load_name`` is not provided, the default is to use the load name if it can be
determined from the backstop directory path. This path must follow the SOT MP
naming convention where the directory path containing the backstop file looks like
``<prefix>/<YEAR>/<MON><DD><YY>/ofls<REV>/*.backstop``. An example would be
``/proj/sot/ska/data/mpcrit1/mplogs/2023/DEC1123/oflsa/CR344_2303.backstop``.
If reading a backstop file from a local directory then the load name should be
provided explicitly.
Examples
--------
Expand Down

0 comments on commit 7f875f1

Please sign in to comment.