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

Docs #268

Merged
merged 16 commits into from
Sep 12, 2023
Merged

Docs #268

merged 16 commits into from
Sep 12, 2023

Conversation

madsbk
Copy link
Member

@madsbk madsbk commented Aug 24, 2023

No description provided.

@madsbk madsbk added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Aug 24, 2023
@madsbk madsbk marked this pull request as ready for review August 28, 2023 11:37
@madsbk madsbk requested review from a team as code owners August 28, 2023 11:37
@jakirkham
Copy link
Member

Thanks Mads! 🙏

Think this will be of great help to users getting started here 🙂

Would it make sense to update this notebook ( #270 ) here too? Or should that be a separate PR?

@madsbk
Copy link
Member Author

madsbk commented Aug 29, 2023

Thanks Mads! 🙏

Think this will be of great help to users getting started here 🙂

Would it make sense to update this notebook ( #270 ) here too? Or should that be a separate PR?

Let's do it in a separate PR, I like to test the notebook separately.

Copy link
Member

@ajschmidt8 ajschmidt8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving ops-codeowner file changes

README.md Outdated Show resolved Hide resolved
cpp/doxygen/main_page.md Outdated Show resolved Hide resolved
cpp/doxygen/main_page.md Outdated Show resolved Hide resolved
cpp/doxygen/main_page.md Outdated Show resolved Hide resolved
docs/source/install.rst Outdated Show resolved Hide resolved
docs/source/zarr.rst Outdated Show resolved Hide resolved
@@ -0,0 +1,11 @@
Zarr
====

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be good to give a brief brief mention of what zarr is:

Zarr is a binary file format for chunked, compressed, N-Dimensional array. It is used throughout the PyData ecosystem and especially for climate and biological science applications.

Something like that ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sound good, added.

madsbk and others added 2 commits August 31, 2023 09:00
Co-authored-by: Benjamin Zaitlen <[email protected]>
@madsbk madsbk requested a review from quasiben August 31, 2023 08:37
@madsbk
Copy link
Member Author

madsbk commented Sep 1, 2023

@quasiben, I think I have addressed all your comments?

@madsbk madsbk closed this Sep 1, 2023
@madsbk madsbk reopened this Sep 1, 2023
Copy link
Contributor

@vuule vuule left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO it would be nice to include information about the environment variables like KVIKIO_NTHREADS in the docs. They are not very visible, especially the default values.

@madsbk
Copy link
Member Author

madsbk commented Sep 7, 2023

KVIKIO_NTHREADS

Good point, added a Runtime Settings section

@vuule
Copy link
Contributor

vuule commented Sep 7, 2023

KVIKIO_NTHREADS

Good point, added a Runtime Settings section

This is great, thank you for adding this!

@madsbk
Copy link
Member Author

madsbk commented Sep 12, 2023

/merge

@rapids-bot rapids-bot bot merged commit 06d9ec9 into rapidsai:branch-23.10 Sep 12, 2023
@madsbk madsbk deleted the docs branch September 12, 2023 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation non-breaking Introduces a non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants