mention strun package name usage in docs (#1476)

spacetelescope · Dec 4, 2024 · fa457d9 · fa457d9
2 parents 573d961 + 814815f
commit fa457d9
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/changes/1476.docs.rst b/changes/1476.docs.rst
@@ -0,0 +1 @@
+Mention possible need to provide package name to strun when using aliases.
diff --git a/docs/roman/pipeline_run.rst b/docs/roman/pipeline_run.rst
@@ -48,6 +48,13 @@ The mosaic level pipeline also has an alias, ``roman_mos``, and can be run as
 
  $ strun roman_mos r0008308002010007027_asn.json
 
+.. note::
+
+   When using an **alias** with strun (for example ``strun resample``) you may
+   need to provide the ``romancal`` 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 romancal::resample``).
+
 
 Exit Status
 ```````````

diff --git a/pyproject.toml b/pyproject.toml
@@ -28,8 +28,8 @@ dependencies = [
     "scipy >=1.11",
     # "stcal>=1.10.0,<1.11.0",
     "stcal @ git+https://github.com/spacetelescope/stcal.git@main",
-    "stpipe >=0.7.0,<0.8.0",
-    # "stpipe @ git+https://github.com/spacetelescope/stpipe.git@main",
+    # "stpipe >=0.7.0,<0.8.0",
+    "stpipe @ git+https://github.com/spacetelescope/stpipe.git@main",
     "tweakwcs >=0.8.8",
     "spherical-geometry >= 1.2.22",
     "stsci.imagestats >= 1.6.3",
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.