Rename reversed to invert

Author: seisman

examples/gallery/symbols/patterns.py

@@ -24,7 +24,7 @@
 
 Theses patterns can be specified via the :class:`pygmt.params.Pattern` class. The
 patterns can be customized with different resolution and different foreground and
-background colors. The foreground and background colors can also be reversed.
+background colors. The foreground and background colors can also be inverted.
 """
 
 # %%
@@ -41,7 +41,7 @@
     # Pattern 19 with custom background ("red3") and foreground ("lightbrown").
     Pattern(19, bgcolor="red3", fgcolor="lightbrown"),
     # Reverse the background and foreground.
-    Pattern(19, reversed=True, bgcolor="red3", fgcolor="lightbrown"),
+    Pattern(19, invert=True, bgcolor="red3", fgcolor="lightbrown"),
     # Same as above, but with a 100 dpi resolution.
     Pattern(19, bgcolor="red3", fgcolor="lightbrown", dpi=100),
     # Same as above, but with a transparent background by setting bgcolor to "".

pygmt/params/pattern.py

@@ -21,7 +21,7 @@ class Pattern(BaseParam):
     24-bit image raster files to fill symbols and polygons in various PyGMT plotting
     methods. The patterns can be customized with different resolution and different
     foreground and background colors. The foreground and background colors can also be
-    reversed.
+    inverted.
 
     GMT provides 90 predefined patterns that can be used in PyGMT. The patterns are
     numbered from 1 to 90, and shown below:
@@ -47,8 +47,8 @@ class Pattern(BaseParam):
         [Default is white for background and black for foreground]. Setting either to
         an empty string will yield a transparent background/foreground where only the
         foreground or background pixels will be painted.
-    reversed
-        If ``True``, the pattern will be bit-reversed, i.e., white and black areas will
+    invert
+        If ``True``, the pattern will be bit-inverted, i.e., white and black areas will
         be interchanged (only applies to predefined bit-patterns or 1-bit images).
 
     Examples
@@ -73,7 +73,7 @@ class Pattern(BaseParam):
     dpi: int | None = None
     bgcolor: str | None = None
     fgcolor: str | None = None
-    reversed: bool = False
+    invert: bool = False
 
     def _validate(self):
         """
@@ -104,7 +104,7 @@ def _aliases(self):
         Aliases for the Pattern class.
         """
         return [
-            Alias(self.pattern, name="pattern", prefix="P" if self.reversed else "p"),
+            Alias(self.pattern, name="pattern", prefix="P" if self.invert else "p"),
             Alias(self.bgcolor, name="bgcolor", prefix="+b"),
             Alias(self.fgcolor, name="fgcolor", prefix="+f"),
             Alias(self.dpi, name="dpi", prefix="+r"),

pygmt/tests/test_params_pattern.py

@@ -24,9 +24,9 @@ def test_pattern():
 
     assert str(Pattern(40, dpi=300)) == "p40+r300"
 
-    assert str(Pattern(50, reversed=True)) == "P50"
+    assert str(Pattern(50, invert=True)) == "P50"
 
-    pattern = Pattern(90, reversed=True, bgcolor="red", fgcolor="blue", dpi=300)
+    pattern = Pattern(90, invert=True, bgcolor="red", fgcolor="blue", dpi=300)
     assert str(pattern) == "P90+bred+fblue+r300"
 
     pattern = Pattern("pattern.png", bgcolor="red", fgcolor="blue", dpi=300)
@@ -42,6 +42,7 @@ def test_pattern_invalid_pattern():
     with pytest.raises(GMTValueError):
         _ = str(Pattern(91))
 
+
 def test_pattern_invalid_colors():
     """
     Test that both fgcolor and bgcolor cannot be empty strings.