Skip to content

Commit

Permalink
Clarify that the "color" parameter in plot/plot3d can be 1d array (#1260
Browse files Browse the repository at this point in the history
)
  • Loading branch information
core-man committed May 8, 2021
1 parent 4777a6f commit 036e2b0
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion pygmt/helpers/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
(e.g., *color1*,\ *color2*,\ *color3*) to build a linear continuous
CPT from those colors automatically.""",
"G": """\
color : str
color : str or 1d array
Select color or pattern for filling of symbols or polygons. Default
is no fill.""",
"V": """\
Expand Down
2 changes: 2 additions & 0 deletions pygmt/src/plot.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,8 @@ def plot(self, x=None, y=None, data=None, size=None, direction=None, **kwargs):
the coordinates of a *refpoint* which will serve as a fixed external
reference point for all groups.
{G}
*color* can be a 1d array, but it is only valid if using ``x``/``y``
and ``cmap=True`` is also required.
intensity : float or bool or 1d array
Provide an *intensity* value (nominally in the -1 to +1 range) to
modulate the fill color by simulating illumination. If using
Expand Down
2 changes: 2 additions & 0 deletions pygmt/src/plot3d.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ def plot3d(
Offset the plot symbol or line locations by the given amounts
*dx*/*dy*\ [/*dz*] [Default is no offset].
{G}
*color* can be a 1d array, but it is only valid if using ``x``/``y``
and ``cmap=True`` is also required.
intensity : float or bool or 1d array
Provide an *intensity* value (nominally in the -1 to +1 range) to
modulate the fill color by simulating illumination. If using
Expand Down

0 comments on commit 036e2b0

Please sign in to comment.