Repository navigation
Refactor and enhance documentation throughout the codebase #29
Description
Update and improve all documentation for cuvarbase, including docstrings, the README, and usage examples. Ensure all public functions and classes have clear docstrings, and that the README accurately reflects current capabilities and installation instructions. Add or update example notebooks or scripts for users.
Activity
johnh2o2 commentedon Jun 12, 2026
v1.0 status. Delivered under this umbrella in the packed release:
docs/source/pdm.rst) + API docs (community PR PDM refactorization and kernel speedup #62)bls.rst/lomb.rst(Document + maybe add some flexibility for powerspectrum convention #17)docs/BENCHMARK_RESULTS.md), with claims either traced to repo data or rephrasedDeferred (v1.1): the all-public-API docstring audit and updated example notebooks. Leaving open for those.
johnh2o2 commentedon Sep 28, 2026
Release triage for PR #69 (cuvarbase 1.0.1, source
6b6c48945160).This issue remains open and is listed as related follow-up in PR #69; it is intentionally excluded from automatic closure.
The source has updated guides, release/migration notes, examples and corrections to numerical/performance claims. The owner’s June 12 comment left the complete public-API docstring audit and refreshed notebooks open. The current suite still records the known PDM notebook string-escape warning as a strict expected failure. Remaining: finish the full public-API documentation audit and update/validate the notebooks, including that known warning.
Evidence: API documentation index · known PDM notebook warning tracked by a strict expected failure