Document ThreadLocalStream and iinfo in the API reference - #3986
Merged
zcbenz merged 1 commit intoAug 5, 2026
Conversation
zcbenz
approved these changes
Aug 4, 2026
zcbenz
force-pushed
the
docs-add-missing-public-classes
branch
from
August 4, 2026 23:24
85aaaf0 to
f8c1074
Compare
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
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.
Proposed changes
Two public classes are missing from the API reference while their direct counterparts are already listed.
ThreadLocalStreamis whatnew_thread_local_streamreturns, and it shows up in the type stubs as an acceptedstreamargument in essentially every op:StreamandDeviceare both on the devices and streams page, so one of the three types a user can pass has no page to click through to. Building the docs with-nreportstarget not found: mlx.core.ThreadLocalStream65 times, which is what led me here.iinfois the integer counterpart offinfoand works the same way, but onlyfinfois listed on the data types page:Both entries generate their stub pages cleanly and the build adds no new warnings.
I left a few other unlisted names alone since omitting them looks deliberate rather than accidental:
ArrayAt,ArrayIterator,ArrayLike,DeviceType,StreamContextandFunctionExporterare mostly internal or helper types. Glad to add any of them if you would rather they were listed.Checklist
Put an
xin the boxes that apply.pre-commit run --all-filesto format my code / installed pre-commit prior to committing changes(docs only; built the docs before and after and checked the generated stubs)
being upfront as usual: freshman here and Claude Code helps me sweep, but i found these by building the docs in nitpick mode and reading the unresolved references, then checked each class actually exists and runs before adding it. the list of ones i deliberately skipped is a real question, not filler.