cartopy icon indicating copy to clipboard operation
cartopy copied to clipboard

PlateCarree documentation incorrect

Open gholsclaw opened this issue 7 months ago • 1 comments

The documentation for the PlateCarree class is defined with two parameters: cartopy.crs.PlateCarree(central_longitude=0.0, globe=None)

But the parameter description lists "proj4_params" and "globe". Instead of "proj4_params" I believe it should list "central_longitude".

Parameters: proj4_params (iterable of key-value pairs) – The proj4 parameters required to define the desired CRS. The parameters should not describe the desired elliptic model, instead create an appropriate Globe instance. The proj4_params parameters will override any parameters that the Globe defines. globe – If omitted, the default Globe instance will be created.

https://cartopy.readthedocs.io/stable/reference/projections.html#cartopy.crs.PlateCarree

gholsclaw avatar Aug 07 '25 20:08 gholsclaw

It looks like PlateCarree has no docstring, so it's inherited by CRS, which has different parameters.

QuLogic avatar Aug 08 '25 01:08 QuLogic