Repository navigation
Audit standalone documentation, tutorials, and public API - #185
Merged
Merged
Conversation
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.
The guide, API reference, gallery, and all 13 tutorials are self-contained first-release documentation. Experimental datasets and fictional tasks are introduced as illustrative examples, with their assumptions and interpretation limits. PyPI installation instructions and badges preview the release, and the Mitchell tutorial uses the current HyperTools Figure API.
The audit also corrects public behavior: permutation refits use a common label-independent factor reference; undefined statistics retain undefined p-values; spatial inputs reject mismatched registration and complex values; mixture optimization handles vanishing-component scaling and extreme step norms; and plotting keeps readable colorbar ticks and comparable group color scales. Regression tests cover these paths. The group tutorial includes a recomputed, checksum-verified 100-permutation asset.
Performance claims use 24 matched fits on an isolated runner with CPU-interference checks, recorded inputs/settings/source hashes, and downloadable raw monitoring. An independent reviewer verifies the measurements and summary arithmetic. Fresh reviewers also audit the documentation, scientific interpretation, API behavior, and rendered tutorial/gallery outputs.
Download the rendered HTML documentation preview.
Validation:
readme_renderer[md], and its image/document URLs are absolute for PyPI. The README-only packaging correction preserves every packaged library file byte-for-byte.No package publication: PyPI/TestPyPI remain untouched and the GitHub release stays a draft. The Zenodo DOI badge is deferred until after review and the approved release. See
notes/RELEASE_REVIEW.mdfor evidence and remaining publication gates.