fix many documentation disambiguation warnings#333
Merged
davidkoski merged 1 commit intomainfrom Jan 14, 2026
Merged
Conversation
- fix #327 as much as possible - changes from the opaque hash to the new typed style: -/// - ``MLXArray/asType(_:stream:)-6d44y`` +/// - ``MLXArray/asType(_:stream:)-(DType,StreamOrDevice)`` - where possible! - I found that xcode and docc were not able to handle all of the links like this - added missing docs (primarily parameters) where found - this doesn't fix _everything_ as some references are still ambiguous
davidkoski
commented
Jan 13, 2026
| /// - ``MLXArray/asType(_:stream:)-6d44y`` | ||
| /// - ``MLXArray/asType(_:stream:)-4eqoc`` | ||
| /// - ``MLXArray/asType(_:stream:)-(DType,StreamOrDevice)`` | ||
| /// - ``MLXArray/asType(_:stream:)-(HasDType.Type,StreamOrDevice)`` |
Collaborator
Author
There was a problem hiding this comment.
The new form is human readable, which is nice!
davidkoski
commented
Jan 13, 2026
| /// | ||
| /// ### See Also | ||
| /// - ``norm(_:ord:axes:keepDims:stream:)-8zljj`` | ||
| /// - ``norm(_:ord:axes:keepDims:stream:)`` |
Collaborator
Author
There was a problem hiding this comment.
Some of these seem to just be broken. The old hash is incorrect. Using the new format doesn't work (maybe I will eventually figure out why -- this doesn't even have complex types like closures as parameters). For some reason the docc compiler seems happy without the hash.
davidkoski
commented
Jan 13, 2026
| /// Element-wise complex conjugate of the input. | ||
| /// | ||
| /// - Parameters: | ||
| /// - stream: stream or device to evaluate on |
Collaborator
Author
There was a problem hiding this comment.
Where I saw warnings add missing params, etc.
awni
approved these changes
Jan 14, 2026
Member
awni
left a comment
There was a problem hiding this comment.
That's a very nice change.. though looks like a tedious one 😅
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
2 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.
-/// -
MLXArray/asType(_:stream:)-6d44y+/// -
MLXArray/asType(_:stream:)-(DType,StreamOrDevice)where possible!
I found that xcode and docc were not able to handle all of the links like this
added missing docs (primarily parameters) where found
this doesn't fix everything as some references are still ambiguous
Proposed changes
Please include a description of the problem or feature this PR is addressing. If there is a corresponding issue, include the issue #.
Checklist
Put an
xin the boxes that apply.pre-commit run --all-filesto format my code / installed pre-commit prior to committing changes