Skip to content

Commit

Permalink
Merge pull request #728 from alessio26gas/doc/spherical-caps-typo
Browse files Browse the repository at this point in the history
DOC: fixed documentation about spherical caps
  • Loading branch information
Gui-FernandesBR authored Nov 10, 2024
2 parents 69aaece + 6fea165 commit c512c40
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/user/motors/tanks.rst
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 c512c40

Please sign in to comment.