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: add rdataframe user guide #1836

Merged
merged 13 commits into from
Oct 31, 2022
Merged

docs: add rdataframe user guide #1836

merged 13 commits into from
Oct 31, 2022

Conversation

ianna
Copy link
Collaborator

@ianna ianna commented Oct 26, 2022


📚 The documentation for this PR will be available at https://awkward-array.readthedocs.io/en/ianna-rdataframe-user-guide-v1/ once Read the Docs has finished building 🔨

@codecov
Copy link

codecov bot commented Oct 26, 2022

Codecov Report

Merging #1836 (08a9515) into main (fec5eee) will decrease coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files
Impacted Files Coverage Δ
src/awkward/contents/indexedarray.py 76.60% <0.00%> (-0.19%) ⬇️
src/awkward/contents/recordarray.py 83.87% <0.00%> (-0.19%) ⬇️
src/awkward/_util.py 82.21% <0.00%> (-0.18%) ⬇️
src/awkward/contents/indexedoptionarray.py 88.90% <0.00%> (-0.16%) ⬇️
src/awkward/_connect/avro.py 87.17% <0.00%> (-0.14%) ⬇️
src/awkward/types/_awkward_datashape_parser.py 47.72% <0.00%> (-0.01%) ⬇️

@agoose77
Copy link
Collaborator

Hey @ianna, I hope to get the C++ dependency management implemented in #1837. Once that's in, you should be able to add ROOT as a dependency for the docs.

@agoose77
Copy link
Collaborator

@jpivarski I've touched this PR, so it would be best if you were the reviewer.

I've switched the CI from xeus-cling to root as our C++ kernel provider (in addition to the PyROOT integration for this PR). I'm re-using the same environment spec for wheel building and consumption to mitigate the fact that we don't build a manylinux wheel.

Copy link
Member

@jpivarski jpivarski left a comment

Choose a reason for hiding this comment

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

Looks good! (I viewed the rendered docs as well.)

My only complaint is the commented-out code (below). Once that's gone, fee free to merge!

docs-sphinx/environment.yml.cog Show resolved Hide resolved
Copy link
Collaborator Author

@ianna ianna left a comment

Choose a reason for hiding this comment

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

@jpivarski - @agoose77 argument seems convincing. If it resolves the conversation, please, merge it.

@agoose77 agoose77 merged commit f2d9108 into main Oct 31, 2022
@agoose77 agoose77 deleted the ianna/rdataframe-user-guide-v1 branch October 31, 2022 15:32
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 this pull request may close these issues.

3 participants