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

[NFC][DF] Improvements to docs #13385

Merged
merged 3 commits into from Aug 3, 2023
Merged

Conversation

eguiraud
Copy link
Member

@eguiraud eguiraud commented Aug 2, 2023

No description provided.

@eguiraud eguiraud self-assigned this Aug 2, 2023
Copy link
Member

@vepadulano vepadulano left a comment

Choose a reason for hiding this comment

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

I like these additions a lot, thank you! I saw that there was no mention of RDatasetSpec, maybe we want to avoid writing about it for now until it can also support at least some type of join operation. I left a couple of minor comments.

"myFriend.MyCol" in the example above).
"myFriend.MyCol" in the example above if there is no column "MyCol" in the main tree).

\note A common source of confusion is that trees that are written out from a multi-thread Snapshot() call will have their
Copy link
Member

Choose a reason for hiding this comment

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

Maybe a warning could be better in this case since it's a source of confusion, we want people to see this paragraph as easily as possible

Copy link
Member Author

Choose a reason for hiding this comment

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

notes are quite visible and a warning seems to harsh to me: this is a clarification on a concept, not a "don't use this" or "you are probably doing something wrong" kind of thing

image

tree/dataframe/src/RDataFrame.cxx Outdated Show resolved Hide resolved
There is no constructor that accepts more than one tree at the same time.

Co-authored-by: Vincenzo Eduardo Padulano <v.e.padulano@gmail.com>
@eguiraud eguiraud merged commit c7f10ba into root-project:master Aug 3, 2023
3 of 11 checks passed
@eguiraud eguiraud deleted the df-docs branch August 3, 2023 16:08
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.

None yet

2 participants