@@ -33,8 +33,8 @@ class Pattern(BaseParam):
3333
3434 Parameters
3535 ----------
36- id
37- The pattern ID . It can be specified in two forms:
36+ pattern
37+ The pattern to use . It can be specified in two forms:
3838
3939 - An integer in the range of 1-90, corresponding to one of 90 predefined 64x64
4040 bit-patterns
@@ -69,7 +69,7 @@ class Pattern(BaseParam):
6969 >>> fig.show()
7070 """
7171
72- id : int | PathLike
72+ pattern : int | PathLike
7373 dpi : int | None = None
7474 bgcolor : str | None = None
7575 fgcolor : str | None = None
@@ -79,13 +79,13 @@ def _validate(self):
7979 """
8080 Validate the parameters.
8181 """
82- # Integer pattern id must be in the range 1-90.
83- if isinstance (self .id , int ) and not (1 <= self .id <= 90 ):
82+ # Integer pattern number must be in the range 1-90.
83+ if isinstance (self .pattern , int ) and not (1 <= self .pattern <= 90 ):
8484 raise GMTValueError (
85- self .id ,
86- description = "pattern id " ,
85+ self .pattern ,
86+ description = "pattern number " ,
8787 reason = (
88- "Pattern id must be an integer in the range 1-90 "
88+ "Parameter 'pattern' must be an integer in the range 1-90 "
8989 "or the name of a 1-, 8-, or 24-bit image raster file."
9090 ),
9191 )
@@ -104,7 +104,7 @@ def _aliases(self):
104104 Aliases for the Pattern class.
105105 """
106106 return [
107- Alias (self .id , name = "id " , prefix = "P" if self .reversed else "p" ),
107+ Alias (self .pattern , name = "pattern " , prefix = "P" if self .reversed else "p" ),
108108 Alias (self .bgcolor , name = "bgcolor" , prefix = "+b" ),
109109 Alias (self .fgcolor , name = "fgcolor" , prefix = "+f" ),
110110 Alias (self .dpi , name = "dpi" , prefix = "+r" ),
0 commit comments