Skip to content

Commit

Permalink
docs/sync-after-context-info (#1060)
Browse files Browse the repository at this point in the history
* revert back to v1 zendesk action

* add example use of after-context sync flag

* update changelog

* increment PR number in changelog

* resolve broken test
  • Loading branch information
alphasentaurii authored Aug 29, 2024
1 parent f9a836d commit 9b0ea25
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 1 deletion.
9 changes: 9 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
11.18.2 (unreleased)
====================

Documentation
-------------

- Added info on using "--after-context" flag in the crds.sync command line help output. The web user guide (command line tools page) has been updated as well to include this information. [#1060]


11.18.1 (2024-07-26)
====================

Expand Down
6 changes: 6 additions & 0 deletions crds/sync.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,12 @@ class SyncScript(cmdline.ContextsScript):
this will also recursively download all the mappings referred to by .pmaps 0001, 002, 0003.
AFTER CONTEXT: Sync all contexts after and including the specified context.
% crds sync --after-context roman_0061.pmap
will recursively download all the mappings starting from the minimum context specified.
Synced contexts can be specified as --all contexts::
% crds sync --all
Expand Down
10 changes: 10 additions & 0 deletions documentation/crds_users_guide/source/command_line_tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,16 @@ cache which organizes and can locate files in a standard way.
this will also recursively download all the mappings referred to by .pmaps
0001, 002, 0003.


After Context: Specify a Minimum Context to Sync:

.. code-block:: bash
$ crds sync --after-context roman_0062.pmap
will recursively download all contexts after and including the specified context.


Synced contexts can be specified as `--all` contexts:

Expand Down
2 changes: 1 addition & 1 deletion test/bestrefs/test_bestrefs.py
Original file line number Diff line number Diff line change
Expand Up @@ -543,7 +543,7 @@ def test_bestrefs_update_headers(self):
with open(f"{self._tmp}/test_cos_combined.json") as pfile:
header = json.load(pfile)
header = header["LCE31SW6Q:LCE31SW6Q"]
assert header["BADTTAB"] == "N/A"
assert header["BADTTAB"] == "S7O1739KL_BADT.FITS"
assert header["GSAGTAB"] == "X6L1439EL_GSAG.FITS"
assert header["FLATFILE"] == "N/A"

Expand Down

0 comments on commit 9b0ea25

Please sign in to comment.