DOC : Add compile state example#2910
Merged
awni merged 2 commits intoml-explore:mainfrom Dec 16, 2025
Merged
Conversation
Contributor
Author
|
Thanks for the approval, @awni ! Is there anything else you need from my side before this is ready to be merged? |
1 task
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
This PR addresses an inconsistency in the "Pure Functions" subsection of the
mlx.compiledocumentation.The guide currently mentions two methods for capturing mutable external state, but only provides a code example for the second method.
Problem: The text states, "The first option is to simply pass
stateas input to the function," but this method was not demonstrated with code.Solution: This change inserts the missing code block, which explicitly shows the technique of passing
stateas an argument. This provides a clear contrast between the two options and improves the overall clarity and completeness of the documentation section.Checklist
Put an
xin the boxes that apply.pre-commit run --all-filesto format my code / installed pre-commit prior to committing changes