Skip to content

Commit

Permalink
Clean up and correct docstring.
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewdnolan committed Dec 19, 2024
1 parent 1c951b5 commit 5723b57
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions mosaic/polypcolor.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,10 @@ def polypcolor(
"""
Create a pseudocolor plot of a unstructured MPAS grid.
Call signatures::
polypcolor(ax, descriptor, c, *, ...)
The unstructued grid can be specified either by passing a
:py:class:`mosaic.Descriptor` object as the second parameter, or by
passing the mesh datatset. See :py:class:`mosaic.Descriptor` for an
explanation of what the ``mesh_dataset`` has to be.
The unstructured grid is specified by passing a
:py:class:`~mosaic.Descriptor` object as the second parameter.
See :py:class:`mosaic.Descriptor` for an explanation of what the
``Descriptor`` is and how to construct it.
Parameters
----------
Expand All @@ -46,8 +42,8 @@ def polypcolor(
``nCells``, ``nEdges``, or ``nVertices``.
other_parameters
All other parameters including the ``kwargs`` are the same as
for :py:func:`matplotlib.pyplot.pcolor`.
All other parameters are the same as for
:py:func:`~matplotlib.pyplot.pcolor`.
"""

if "nCells" in c.dims:
Expand Down

0 comments on commit 5723b57

Please sign in to comment.