Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: fixed documentation about spherical caps #728

Merged
merged 1 commit into from
Nov 10, 2024
Merged

DOC: fixed documentation about spherical caps #728

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/user/motors/tanks.rst
View file
Open in desktop
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