Skip to content

Commit

Permalink
Move caution above parameters in Ellipsoid docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
santisoler committed Oct 10, 2024
1 parent 965e903 commit af53cf9
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions boule/_ellipsoid.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ class Ellipsoid:
**Units:** All input parameters and derived attributes are in SI units.
.. caution::
The :class:`boule.Ellipsoid` class with a flattening of zero is not
equivalent to the :class:`boule.Sphere` class. The internal density
structure of an Ellipsoid is unspecified, but must give rise to a
constant gravity potential on the Ellipsoid surface. For a Sphere, the
internal density depends only on radius, and when the angular velocity
is greater than zero, the gravity potential on the surface varies with
latitude.
Parameters
----------
name : str
Expand Down Expand Up @@ -62,17 +73,6 @@ class Ellipsoid:
comments : str or None
Additional comments regarding the ellipsoid (optional).
.. caution::
The :class:`boule.Ellipsoid` class with a flattening of zero is not
equivalent to the :class:`boule.Sphere` class. The internal density
structure of an Ellipsoid is unspecified, but must give rise to a
constant gravity potential on the Ellipsoid surface. For a Sphere, the
internal density depends only on radius, and when the angular velocity
is greater than zero, the gravity potential on the surface varies with
latitude.
Examples
--------
Expand Down

0 comments on commit af53cf9

Please sign in to comment.