mention strun package name usage in docs (#8926)

spacetelescope · Oct 28, 2024 · bf7cf89 · bf7cf89
2 parents b4c09b7 + 8d2b64c
commit bf7cf89
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/changes/8926.docs.rst b/changes/8926.docs.rst
@@ -0,0 +1 @@
+Mention possible need to provide package name to strun when using aliases.
diff --git 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 <pipelines>`.
 
+
+.. 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
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Mention possible need to provide package name to strun when using aliases.