scverse / spatialdata

An open and interoperable data framework for spatial omics data
https://spatialdata.scverse.org/
BSD 3-Clause "New" or "Revised" License
237 stars 45 forks source link

Adding glossary + refactor API reference display #785

Open quentinblampey opened 1 week ago

quentinblampey commented 1 week ago

@LucaMarconato actually the issue I had with some functions not being displayed in the docs is because they were not documented. This is mostly for the transformations (MapAxis, Affine, ...) and the models. Should we document everything or keep it like that? Meanwhile, I added :undoc-members: so that methods with no docs are still displayed.

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.84%. Comparing base (27bb4a7) to head (561bfb8). Report is 12 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #785 +/- ## ========================================== - Coverage 91.89% 91.84% -0.05% ========================================== Files 45 45 Lines 6919 6893 -26 ========================================== - Hits 6358 6331 -27 - Misses 561 562 +1 ``` | [Files with missing lines](https://app.codecov.io/gh/scverse/spatialdata/pull/785?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scverse) | Coverage Δ | | |---|---|---| | [src/spatialdata/\_core/query/spatial\_query.py](https://app.codecov.io/gh/scverse/spatialdata/pull/785?src=pr&el=tree&filepath=src%2Fspatialdata%2F_core%2Fquery%2Fspatial_query.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scverse#diff-c3JjL3NwYXRpYWxkYXRhL19jb3JlL3F1ZXJ5L3NwYXRpYWxfcXVlcnkucHk=) | `95.46% <ø> (-0.02%)` | :arrow_down: | | [src/spatialdata/transformations/transformations.py](https://app.codecov.io/gh/scverse/spatialdata/pull/785?src=pr&el=tree&filepath=src%2Fspatialdata%2Ftransformations%2Ftransformations.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scverse#diff-c3JjL3NwYXRpYWxkYXRhL3RyYW5zZm9ybWF0aW9ucy90cmFuc2Zvcm1hdGlvbnMucHk=) | `94.61% <ø> (ø)` | | ... and [28 files with indirect coverage changes](https://app.codecov.io/gh/scverse/spatialdata/pull/785/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=scverse)