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

Slice is mentioned in documentation but not exported. #86

Open
dblodgett-usgs opened this issue Jun 1, 2024 · 1 comment
Open

Slice is mentioned in documentation but not exported. #86

dblodgett-usgs opened this issue Jun 1, 2024 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@dblodgett-usgs
Copy link
Collaborator

https://keller-mark.github.io/pizzarr/reference/slice.html refers to the internal Slice class. Should Slice be exported or should we fix up documentation so it doesn't point to it?

@dblodgett-usgs dblodgett-usgs added the bug Something isn't working label Jun 1, 2024
@keller-mark
Copy link
Owner

keller-mark commented Jun 18, 2024

It was intentional not to export the class, and instead export the utility functions that use the class internally

@keller-mark keller-mark added the documentation Improvements or additions to documentation label Jun 18, 2024
dblodgett-usgs added a commit to dblodgett-usgs/pizzarr that referenced this issue Jun 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants