Skip to content

Fix incorrect docstring return order in shiftdata() #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 12, 2025
Merged

Fix incorrect docstring return order in shiftdata() #624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89b31f8
Fix incorrect docstring return order in shiftdata()
Cdiaz1234 Apr 9, 2025
3acfbc7
Fix docstring indentation after content fix
molinav Jun 12, 2025
0fe4496
Merge remote-tracking branch 'upstream/develop' into fix-docs-shiftdata
molinav Jun 12, 2025
ed018c7
Update CHANGELOG
molinav Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ https://semver.org/spec/v2.0.0.html

### Fixed
- Fix Cython extension to use `noexcept` (PR [#615] by @cvanelteren).
- Fix incorrect return order described in `Basemap.shiftdata` docstring
(PR [#624] by @Cdiaz1234, solves issue [#599]).

### Removed
- Deprecated `bdist_wheel.universal` option when building wheels.
Expand Down Expand Up @@ -1157,6 +1159,8 @@ https://semver.org/spec/v2.0.0.html
- Fix glitches in drawing of parallels and meridians.


[#624]:
https://github.com/matplotlib/basemap/pull/624
[#623]:
https://github.com/matplotlib/basemap/pull/623
[#622]:
Expand All @@ -1177,6 +1181,8 @@ https://github.com/matplotlib/basemap/pull/614
https://github.com/matplotlib/basemap/issues/608
[#604]:
https://github.com/matplotlib/basemap/issues/604
[#599]:
https://github.com/matplotlib/basemap/issues/599
[#598]:
https://github.com/matplotlib/basemap/pull/598
[#595]:
Expand Down
9 changes: 5 additions & 4 deletions packages/basemap/src/mpl_toolkits/basemap/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4836,10 +4836,11 @@ def shiftdata(self,lonsin,datain=None,lon_0=None,fix_wrap_around=True):
[lon_0-180, lon_0+180] range.
================ ======================================================

if datain given, returns ``dataout,lonsout`` (data and longitudes shifted to fit in interval
[lon_0-180,lon_0+180]), otherwise just returns longitudes. If
transformed longitudes lie outside map projection region, data is
masked and longitudes are set to 1.e30.
If datain is given, returns ``lonsout, dataout`` (longitudes and data
shifted to fit in the interval [lon_0-180, lon_0+180]); otherwise,
returns just the shifted longitudes. If transformed longitudes lie
outside the map projection region, data is masked and longitudes are
set to 1.e30.
"""
if lon_0 is None and 'lon_0' not in self.projparams:
raise ValueError('lon_0 keyword must be provided')
Expand Down