docs: clarify max_num_elements behavior - #1682
Open
sapunyangkut wants to merge 2 commits into
Open
Conversation
ariostas
reviewed
Jul 16, 2026
Member
|
Thank you @sapunyangkut! I suggested a small tweak. Also, please make the similar modifications to |
Member
|
Sorry @sapunyangkut, I should have merged this earlier. #1702 touched the same parts of the code, so now there are some conflicts. Let me know if you can resolve the conflicts so we can merge this. |
Apply review feedback consistently to open, iterate, concatenate, dask, TTree, and RNTuple documentation. Developed and checked with OpenAI Codex assistance.
sapunyangkut
force-pushed
the
codex/issue-1429-max-num-elements-docs
branch
from
August 23, 2026 11:32
3b8153f to
ed7849c
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
|
sapunyangkut
marked this pull request as ready for review
August 23, 2026 12:00
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
max_num_elementslimits byte ranges in one XRootD vector readentry_stopwhen they want to limit the number of TTree entries readCloses #1429.
Validation
python -m compileall -q src/uproot/reading.pyuproot.openand asserted that the rendered docstring contains the new clarification and cross-referenceuproot.open; the patched docstring produced the same 14 pre-existing warnings as the unmodified baseline and no new warningThe full repository Sphinx build was also attempted. On Windows it stops in the existing
docs-sphinx/prepare_docstrings.pypath handling because it searches foruproot/in a backslash-based__file__path; this is unrelated to the documentation change.AI assistance
OpenAI Codex was used to investigate the issue, draft the wording, and run local validation. The final diff and validation evidence were reviewed by the contributor before submission.