Skip to content

Commit 3824ad9

Browse files
committed
Merge branch 'fix-double-notes' into 'development'
Restrict docstring to single Notes section See merge request damask/DAMASK!1039
2 parents 7bf0400 + dbec1c5 commit 3824ad9

File tree

2 files changed

+3
-7
lines changed

2 files changed

+3
-7
lines changed

python/damask/_orientation.py

+3-5
Original file line numberDiff line numberDiff line change
@@ -983,11 +983,9 @@ def from_fiber_component(crystal: IntSequence,
983983
984984
Ranges 0≤θ≤π and 0≤φ≤2π give a unique set of coordinates.
985985
986-
Notes
987-
-----
988-
The value for sigma should be small enough to avoid values
989-
larger than the maximum disorientation of the crystal family
990-
when sampling from a normal distribution.
986+
The value for sigma should be selected small enough such that
987+
sampling from a normal distribution does not result in values
988+
larger than the maximum disorientation of the crystal family.
991989
The maximum disorientation angle d_max is 62.80°, 93.84°,
992990
98.43°, and 120° for cubic, hexagonal, tetragonal, and
993991
orthorhombic crystal families, respectively.

python/damask/_rotation.py

-2
Original file line numberDiff line numberDiff line change
@@ -1412,8 +1412,6 @@ def from_fiber_component(crystal: IntSequence,
14121412
14131413
Ranges 0≤θ≤π and 0≤φ≤2π give a unique set of coordinates.
14141414
1415-
Notes
1416-
-----
14171415
The value for sigma should be small enough to avoid values
14181416
larger than π when sampling from a normal distribution.
14191417
A typically safe value is σ = π/5 ≈ 36°.

0 commit comments

Comments
 (0)