Repository navigation
Docs: 10-minute start, one guide per task, shorter pages - #23
Merged
Merged
Conversation
…section, API by task
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Documentation build overview
35 files changed ·
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #23 +/- ##
=======================================
Coverage 88.04% 88.04%
=======================================
Files 15 15
Lines 1974 1974
=======================================
Hits 1738 1738
Misses 236 236 🚀 New features to boost your workflow:
|
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: The PR restructures the docs into a 10-minute start, one guide per task, a reference section and a development section, and cuts the prose by about half. It is meant to go in before the 0.3.0 release.
Structure
quickstart("diffsvg in 10 minutes", new). It loads the example data, computes the distances, bins with organoids as replicates, runs the shape test, shows the volcano plot and curves, and runs one gene-set test. It also says what to change for your own data.replicates_tutorial("Comparing conditions with replicates"): the shape, level and slope tests, how to read and check the hits, and gene sets. About 20% shorter.settings_and_clustering(wasfull_tutorial): the stability grid and clustering. The pooled "quickstart" on the model without replicates is removed, and so is the cell-fit toggle, because cell fits test the whole distance range. Every figure and table now has a reading.without_replicates(wassingle_slide_test): one gene against the rest, now on a control section where the anchor is a real SHH domain. The TODO notes and timings are removed, the Moran's I benchmark is cut to one paragraph, and the page says that its p-values come from cells and serve only for ranking.test_comparison_legnini(moved tobenchmarks/notebooks/onprototype/all-prs) and the templatereferences.md. The old URLs redirect on Read the Docs.The README is shorter: what diffsvg does, install, and one line per guide on when to read it.
Review
The 4-persona panel (biologist, statistician, scverse maintainer, newcomer) read the rendered pages, and their findings are fixed. Examples:
Checks
main, with stderr and local paths stripped.hatch run docs:build(-W) passes, and pre-commit passes.