Skip to content

Commit

Permalink
DOC: fixed documentation about spherical caps
Browse files Browse the repository at this point in the history
  • Loading branch information
@alessio26gas @Gui-FernandesBR
alessio26gas authored and Gui-FernandesBR committed Nov 10, 2024
1 parent 69aaece commit 6fea165
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/user/motors/tanks.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,9 @@ The predefined ``CylindricalTank`` class is easy to use and is defined as such:

.. note::
The ``spherical_caps`` parameter is optional and defaults to ``False``. If set
to ``True``, the tank will be defined as a cylinder with flat caps.
If True, the tank will have spherical caps.
to ``True``, the tank will have spherical caps at the top and bottom with the
same radius as the cylindrical part. If set to ``False``, the tank will
be defined as a cylinder with flat caps.

The predefined ``SphericalTank`` is defined with:

Expand Down

0 comments on commit 6fea165

Please sign in to comment.