Skip to content

docs: catalog download size; manifests record the release only when version= is set - #64

Merged
timtreis merged 1 commit into
mainfrom
docs-quickstart-qc
Nov 2, 2026
Merged

timtreis merged 1 commit into
mainfrom
docs-quickstart-qc

Conversation

@timtreis

@timtreis timtreis commented Nov 2, 2026

Copy link
Copy Markdown
Member

Summary: Two corrections to docs/start.md, found by running every snippet on that page from a clean install of v0.1.3.

  • The first Catalog() call now downloads 8.7 MB, not "about 7 MB". The page now says "under 10 MB", which stays true for a few more releases.
  • The section on reproducible references tells readers to record the release, but a manifest.json written from Catalog() without version stores catalog_version: null, both from to_sdata(dest=...) and from sddb-cli download. The page now says so, and tells readers to pass version= when the manifest should record the release.

Every other snippet on the page ran as documented, with uv and with pip on Python 3.12 and an empty SDDB_CACHE_DIR. That covers one dataset, the stem, partial elements with dest, a collection with licenses() and to_dict(), cohort() including the KeyError for an unknown uid, version= with a canonical_key, the assay and technology queries, and both CLI commands.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 spatialdata-db | 🛠️ Build #35568780 | 📁 Comparing 515561e against latest (519145a)

  🔍 Preview build  

2 files changed
± start.html
± reference/catalog-columns.html

@codecov

codecov Bot commented Nov 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.64%. Comparing base (00c0467) to head (515561e).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #64   +/-   ##
=======================================
  Coverage   94.64%   94.64%           
=======================================
  Files          22       22           
  Lines        2278     2278           
=======================================
  Hits         2156     2156           
  Misses        122      122           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis merged commit 4ac1f00 into main Nov 2, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant