Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved docs: adding glossary + refactor API reference display #785

Merged
merged 9 commits into from
Jan 4, 2025

Conversation

quentinblampey
Copy link
Contributor

  • Adding a glossary to the docs
  • Updating docs display (sections on the left, functions on the right)
  • Adding docstrings to all functions missing docstrings

@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.

Copy link

codecov bot commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.79%. Comparing base (0ba1cf9) to head (aba3a04).
Report is 12 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #785   +/-   ##
=======================================
  Coverage   91.79%   91.79%           
=======================================
  Files          45       45           
  Lines        7118     7118           
=======================================
  Hits         6534     6534           
  Misses        584      584           
Files with missing lines Coverage Δ
src/spatialdata/_core/query/spatial_query.py 95.50% <ø> (ø)
src/spatialdata/transformations/transformations.py 94.61% <ø> (ø)

@LucaMarconato LucaMarconato linked an issue Jan 4, 2025 that may be closed by this pull request
@LucaMarconato LucaMarconato merged commit b9ddf1b into scverse:main Jan 4, 2025
8 checks passed
@LucaMarconato
Copy link
Member

Great work @quentinblampey!

@LucaMarconato LucaMarconato changed the title Adding glossary + refactor API reference display Improved docs: adding glossary + refactor API reference display Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a glossary in the docs
2 participants