Uh oh!
There was an error while loading. Please reload this page.
Add readthedocs page for mapca - #46
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@## main #46 +/- ##
=======================================
Coverage 90.42% 90.42% =======================================
Files 3 3 Lines 282 282 =======================================
Hits 255 255 Misses 27 27 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
handwerkerd
commented
Feb 11, 2022
Great start! My one general comment is that, as a learning tool, it would be nice to have a few more "why" comments instead of the current "what" comments. That is, you include things like "Step 2: Apply kurtosis threshold of Gaussianity to SVD data to get first estimate of subsampling depth" without saying why this step is happening. This doesn't have to be a textbook level of detail, but a sentence or two at the beginning of each code block explain why each step is done would help. |
- Add comprehensive Sphinx documentation infrastructure (conf.py, Makefile, index.rst, api.rst, installation.rst) - Refactor pipeline.ipynb with detailed "why" explanations for pipeline steps per review feedback - Fix n_Crit typo and complete incomplete comments in code - Update .readthedocs.yml configuration Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
OSF now returns HTTP 308 Permanent Redirect which Python's urlretrieve cannot handle. Switch to requests.get() which follows all redirects. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Closes#42 .
This PR adds the documentation related to the package.