Skip to content

Commit a3d9d5b

Browse files
Update return type docstings
1 parent c0bf074 commit a3d9d5b

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

sectionproperties/analysis/section.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2169,7 +2169,9 @@ def get_stress_at_point(
21692169
By default, `numpy.average` is used.
21702170
:type agg_function: function, optional
21712171
:return: Resultant normal and shear stresses (sigma_zz, tau_xz, tau_yz)
2172-
:rtype: tuple(float, float, float)
2172+
:return: Resultant normal and shear stresses list[(sigma_zz, tau_xz, tau_yz)]. If a point it not in the
2173+
section then None is returned.
2174+
:rtype: Union[Tuple[float, float, float], None]
21732175
"""
21742176
sigs = self.get_stress_at_points(
21752177
[pt], N, Mxx, Myy, M11, M22, Mzz, Vx, Vy, agg_func
@@ -2207,8 +2209,9 @@ def get_stress_at_points(
22072209
(sigma_zz, tau_xz, tau_yz) are retrieved from each element and combined according to this function.
22082210
By default, `numpy.average` is used.
22092211
:type agg_function: function, optional
2210-
:return: Resultant normal and shear stresses list[(sigma_zz, tau_xz, tau_yz)]
2211-
:rtype: list[tuple(float, float, float)]
2212+
:return: Resultant normal and shear stresses list[(sigma_zz, tau_xz, tau_yz)]. If a point it not in the
2213+
section then None is returned for that element in the list.
2214+
:rtype: List[Union[Tuple[float, float, float], None]]
22122215
"""
22132216

22142217
action = {

0 commit comments

Comments
 (0)