Skip to content

Commit

Permalink
docs: add docstring to test_memory_block_rod
Browse files Browse the repository at this point in the history
  • Loading branch information
sy-cui committed Sep 7, 2023
1 parent 4dfeb88 commit f9d83d3
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions tests/test_modules/test_memory_block_cosserat_rod.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,20 @@ def test_construct_memory_block_structures_for_cosserat_rod(n_rods):
@pytest.mark.parametrize("n_straight_rods", [0, 1, 2, 5])
@pytest.mark.parametrize("n_ring_rods", [0, 1, 2, 5])
def test_memory_block_rod(n_straight_rods, n_ring_rods):
"""
Test memory block logic for Cosserat rods. This test suite supports
a mixture of straight rods and ring rods, the order of which is internally
randomized. Correct system indexing is required within the memory block
implementation to pass this test.
Parameters
----------
n_straight_rods: int
Number of straight rods.
n_ring_rods: int
Number of ring rods.
"""

n_rods = n_straight_rods + n_ring_rods

Expand Down

0 comments on commit f9d83d3

Please sign in to comment.