Skip to content
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.

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

Typo in documentation for registration of custom backend #8644

Closed
2 of 5 tasks
HertugHelms opened this issue Jan 23, 2024 · 1 comment · Fixed by #8645
Closed
2 of 5 tasks

Typo in documentation for registration of custom backend #8644

HertugHelms opened this issue Jan 23, 2024 · 1 comment · Fixed by #8645
Labels
bug needs triage Issue that has not been reviewed by xarray team member

Comments

@HertugHelms
Copy link
Contributor

What happened?

Minor issue, but the documentation for the pyproject.toml version of packaging your custom backend has the entry point as "xarray-backends" where it should be "xarray.backends".
https://docs.xarray.dev/en/latest/internals/how-to-add-new-backend.html

I have created a pull request for the typo

What did you expect to happen?

I expected my custom engine to be discovered by xarray.backends.list_engines() but it didn't work.

Minimal Complete Verifiable Example

No response

MVCE confirmation

  • Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue in xarray.
  • Complete example — the example is self-contained, including all data and the text of any traceback.
  • Verifiable example — the example copy & pastes into an IPython prompt or Binder notebook, returning the result.
  • New issue — a search of GitHub Issues suggests this is not a duplicate.
  • Recent environment — the issue occurs with the latest version of xarray and its dependencies.

Relevant log output

No response

Anything else we need to know?

No response

Environment

INSTALLED VERSIONS

commit: None
python: 3.11.7 (main, Dec 19 2023, 20:42:30) [GCC 10.2.1 20210110]
python-bits: 64
OS: Linux
OS-release: 5.15.133.1-microsoft-standard-WSL2
machine: x86_64
processor:
byteorder: little
LC_ALL: None
LANG: C.UTF-8
LOCALE: ('en_US', 'UTF-8')
libhdf5: 1.12.2
libnetcdf: 4.9.3-development

xarray: 2024.1.0
pandas: 2.2.0
numpy: 1.26.3
scipy: None
netCDF4: 1.6.5
pydap: None
h5netcdf: None
h5py: None
Nio: None
zarr: None
cftime: 1.6.3
nc_time_axis: None
iris: None
bottleneck: None
dask: None
distributed: None
matplotlib: None
cartopy: None
seaborn: None
numbagg: None
fsspec: None
cupy: None
pint: None
sparse: None
flox: None
numpy_groupies: None
setuptools: 69.0.3
pip: 23.3.2
conda: None
pytest: 7.4.4
mypy: None
IPython: 8.20.0
sphinx: None
/usr/local/lib/python3.11/site-packages/_distutils_hack/init.py:33: UserWarning: Setuptools is replacing distutils.
warnings.warn("Setuptools is replacing distutils.")

@HertugHelms HertugHelms added bug needs triage Issue that has not been reviewed by xarray team member labels Jan 23, 2024
Copy link

welcome bot commented Jan 23, 2024

Thanks for opening your first issue here at xarray! Be sure to follow the issue template!
If you have an idea for a solution, we would really welcome a Pull Request with proposed changes.
See the Contributing Guide for more.
It may take us a while to respond here, but we really value your contribution. Contributors like you help make xarray better.
Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug needs triage Issue that has not been reviewed by xarray team member
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant