Merge pull request #236 from lnevay/solid-docstring-fix

Solid docstring fix
g4edge · Feb 16, 2025 · 75485ec · 75485ec
2 parents 0bbe199 + d135fc4
commit 75485ec
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/src/pyg4ometry/geant4/solid/Box.py b/src/pyg4ometry/geant4/solid/Box.py
@@ -79,11 +79,11 @@ class Box(_SolidBase):
 
     :param name: of solid for registry
     :type name: str
-    :param pX: length along x
+    :param pX: full length along x
     :type pX: float, Constant, Quantity, Variable, Expression
-    :param pY: length along y
+    :param pY: full length along y
     :type pY: float, Constant, Quantity, Variable, Expression
-    :param pZ: length along z
+    :param pZ: full length along z
     :type pZ: float, Constant, Quantity, Variable, Expression
     :param registry: for storing solid
     :type registry: Registry

diff --git a/src/pyg4ometry/geant4/solid/Cons.py b/src/pyg4ometry/geant4/solid/Cons.py
@@ -34,7 +34,7 @@ class Cons(_SolidBase):
     :type pRMin2: float, Constant, Quantity, Variable
     :param pRMax2: outer radius at +pDz/2
     :type pRMax2: float, Constant, Quantity, Variable
-    :param pDz: length along z
+    :param pDz: full length along z
     :type pDz: float, Constant, Quantity, Variable
     :param pSPhi: starting phi angle
     :type pSPhi: float, Constant, Quantity, Variable

diff --git a/src/pyg4ometry/geant4/solid/CutTubs.py b/src/pyg4ometry/geant4/solid/CutTubs.py
@@ -30,7 +30,7 @@ class CutTubs(_SolidBase):
     :type pRMin: float, Constant, Quantity, Variable
     :param pRMax: Outer radius
     :type pRMax: float, Constant, Quantity, Variable
-    :param pDz: length along z
+    :param pDz: full length along z
     :type pDz: float, Constant, Quantity, Variable
     :param pSPhi: starting phi angle
     :type pSPhi: float, Constant, Quantity, Variable

diff --git a/src/pyg4ometry/geant4/solid/EllipticalTube.py b/src/pyg4ometry/geant4/solid/EllipticalTube.py
@@ -30,7 +30,7 @@ class EllipticalTube(_SolidBase):
     :type pDx:   float, Constant, Quantity, Variable, Expression
     :param pDy:  length in y
     :type pDy:   float, Constant, Quantity, Variable, Expression
-    :param pDz:  length in z
+    :param pDz:  full length in z
     :type pDz:   float, Constant, Quantity, Variable, Expression
     :param registry: for storing solid
     :type registry: Registry