From 1d172753fd777a59be3969e9ee83d9772b903e2d Mon Sep 17 00:00:00 2001 From: Brett Date: Mon, 28 Oct 2024 09:05:47 -0400 Subject: [PATCH 1/2] mention strun package name usage in docs --- .../user_documentation/running_pipeline_command_line.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/jwst/user_documentation/running_pipeline_command_line.rst b/docs/jwst/user_documentation/running_pipeline_command_line.rst index 3c87dd3dc9..70465b1b6c 100644 --- a/docs/jwst/user_documentation/running_pipeline_command_line.rst +++ b/docs/jwst/user_documentation/running_pipeline_command_line.rst @@ -48,6 +48,14 @@ has the alias ``calwebb_detector1`` and can be run as A full list of pipeline aliases can be found in :ref:`Pipeline Stages `. + +.. note:: + + When using an **alias** with strun (for example ``strun resample``) you may + need to provide the ``jwst`` package name if you have other packages installed + that also use the same **alias**. The package name is provided prior to the + **alias** separated by ``::`` (for example ``strun jwst::resample``). + .. _exit_status: Exit Status From 8d2b64c73a50f11cfd27026e2f21592a3c9e8e40 Mon Sep 17 00:00:00 2001 From: Brett Date: Mon, 28 Oct 2024 09:18:01 -0400 Subject: [PATCH 2/2] add changelog fragment --- changes/8926.docs.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 changes/8926.docs.rst diff --git a/changes/8926.docs.rst b/changes/8926.docs.rst new file mode 100644 index 0000000000..621c1a9254 --- /dev/null +++ b/changes/8926.docs.rst @@ -0,0 +1 @@ +Mention possible need to provide package name to strun when using aliases.