Skip to content

add descriptions of some options in uproot.open - #1702

Open
tomeichlersmith wants to merge 7 commits into
scikit-hep:mainfrom
tomeichlersmith:patch-uproot-open-option-descriptions
Open

add descriptions of some options in uproot.open#1702
tomeichlersmith wants to merge 7 commits into
scikit-hep:mainfrom
tomeichlersmith:patch-uproot-open-option-descriptions

Conversation

@tomeichlersmith

Copy link
Copy Markdown

While working on updating the documentation for coffea (scikit-hep/coffea#1615) I saw a few options that were undocumented, so I'm adding a few lines of documentation to them based off my understanding of the code (mostly other docstrings already existing within uproot).

Comment thread src/uproot/reading.py Outdated
Comment thread src/uproot/reading.py Outdated
Comment thread src/uproot/reading.py Outdated
Comment thread src/uproot/reading.py
Comment thread src/uproot/reading.py Outdated
@tomeichlersmith

Copy link
Copy Markdown
Author

Thanks @ariostas , I'll get to the last few broader comments this afternoon

@tomeichlersmith

Copy link
Copy Markdown
Author

Alright, I realized that instead of copying the same text everywhere, we can ..include it to make it easier to update in the future. I can drop the ..include and manually copy the same descriptions everywhere if you prefer.

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.

2 participants