Skip to content

Commit

Permalink
Improved docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
david-zwicker committed Jan 5, 2024
1 parent 0150cd0 commit fbe6f9b
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions pde/grids/spherical.py
Original file line number Diff line number Diff line change
Expand Up @@ -493,8 +493,8 @@ def plot(self, ax, **kwargs):
class PolarSymGrid(SphericalSymGridBase):
r"""2-dimensional polar grid assuming angular symmetry
The angular symmetry implies that states only depend on the radial
coordinate :math:`r`, which is discretized uniformly as
The angular symmetry implies that states only depend on the radial coordinate
:math:`r`, which is discretized uniformly as
.. math::
r_i = R_\mathrm{inner} + \left(i + \frac12\right) \Delta r
Expand All @@ -503,9 +503,8 @@ class PolarSymGrid(SphericalSymGridBase):
\Delta r = \frac{R_\mathrm{outer} - R_\mathrm{inner}}{N}
where :math:`R_\mathrm{outer}` is the outer radius of the grid and
:math:`R_\mathrm{inner}` corresponds to a possible inner radius, which is
zero by default. The radial direction is discretized by :math:`N` support
points.
:math:`R_\mathrm{inner}` corresponds to a possible inner radius, which is zero by
default. The radial direction is discretized by :math:`N` support points.
"""

dim = 2 # dimension of the described space
Expand All @@ -518,8 +517,8 @@ def point_to_cartesian(
) -> np.ndarray:
"""convert coordinates of a point to Cartesian coordinates
This function returns points along the y-coordinate, i.e, the x
coordinates will be zero.
This function returns points along the y-coordinate, i.e, the x coordinates will
be zero.
Args:
points (:class:`~numpy.ndarray`):
Expand Down

0 comments on commit fbe6f9b

Please sign in to comment.