Skip to content

Documentation Header Paths Wrong Due to 0.26.0 Header Reorg #2844

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

Closed
jtramm opened this issue Apr 9, 2025 · 3 comments · Fixed by #2845
Closed

Documentation Header Paths Wrong Due to 0.26.0 Header Reorg #2844

jtramm opened this issue Apr 9, 2025 · 3 comments · Fixed by #2845

Comments

@jtramm
Copy link

jtramm commented Apr 9, 2025

Since the 0.26.0 release (specifically PR #2829), the documentation is all now out of date. The old paths (which are still in use throughout the documentation) are like:

#include "xtensor/xarray.hpp"

But due to PR #2829 in v0.26.0, these would need to be changed to, e.g.,:

#include "xtensor/containers/xarray.hpp"

@JohanMabille - it might be easier to just revert #2829 than to refactor all the docs etc. Users I'm sure would also greatly appreciate having PR #2829 reverted so as to not have to refactor all apps using xtensor as well. Developers using xtensor might also appreciate reverting back to the old header locations so as to not have to deal with problems due to downstream users having 0.25.0 installed vs 0.26.0.

@HunterBelanger
Copy link

An additional problem caused by these changes is that it breaks xtensor-python. It is now impossible to update to the latest xtensor version if you are using xtensor-python in the same project. Not only will the docs for xtensor need updating, but xtensor-python will need to be updated.

Actually, I think all of the xtensor based language libraries and utilities will need to be updated such as xtensor-r, xtensor-zarr, xtensor-blas and more.

@ThisIsFineTM
Copy link
Contributor

ThisIsFineTM commented Apr 9, 2025

I have some spare time. I'll put together a PR that updates the docs with the new paths.

@HunterBelanger as a side note, xtensor-blas has a pending PR for the path updates.

@JohanMabille
Copy link
Member

@HunterBelanger Indeed, downtream projects must be updated; it is on the roadmap, we just didn't have the time to do it yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants