Refresh documentation for v1.5 and fix examples and references - #1
Open
contromo wants to merge 1 commit into
Open
Refresh documentation for v1.5 and fix examples and references#1contromo wants to merge 1 commit into
contromo wants to merge 1 commit into
Conversation
This was referenced Jul 20, 2026
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.
Summary
mainimport_matrixand the automatic mixed-precision options available onmainWhy
The narrative documentation lagged the v1.5.0 release and subsequent development. Several published snippets referenced undefined names, one equation had the wrong sign, and the Li reference pointed to the DOI for a different paper. These issues could mislead users even when the underlying APIs behave correctly.
Validation
git diff --checkThe full notebook-inclusive build was unavailable in the local clone because the notebook files were Git LFS pointers and Git LFS was not installed.
Follow-up work
The Read the Docs integration still needs maintainer attention before the public site will rebuild. Broader autosummary type-reference, duplicate-object, and Conv1d docstring warnings are intentionally left for a separate change.