Skip to content

Updating documentation displaying dataset versions and partial downloads - #663

Merged
magdalenafuentes merged 10 commits into
mir-dataset-loaders:masterfrom
Masetto96:docs-update-dataset
Aug 1, 2025
Merged

Updating documentation displaying dataset versions and partial downloads#663
magdalenafuentes merged 10 commits into
mir-dataset-loaders:masterfrom
Masetto96:docs-update-dataset

Conversation

@Masetto96

@Masetto96 Masetto96 commented Apr 2, 2025

Copy link
Copy Markdown
Collaborator

This PR improves the documentation by explicitly listing available versions for each dataset as well as possible partial downloads.

Solution: Created a Sphinx extension that automatically modifies docstrings to include this missing information.

fixes #594
resolves #525

@Masetto96 Masetto96 added the docs Updates/fixes to Docs label Apr 2, 2025
@codecov

codecov Bot commented Apr 2, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.05%. Comparing base (b319066) to head (4cbc43d).
⚠️ Report is 9 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #663   +/-   ##
=======================================
  Coverage   97.05%   97.05%           
=======================================
  Files          68       68           
  Lines        7363     7363           
=======================================
  Hits         7146     7146           
  Misses        217      217           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@magdalenafuentes

Copy link
Copy Markdown
Collaborator

@Masetto96 this PR has a conflict, can you check it out?

@magdalenafuentes
magdalenafuentes merged commit 1d72c32 into mir-dataset-loaders:master Aug 1, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Updates/fixes to Docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

There is no documentation on dataset versions Clearer documentation for available dataset versions and partial downloads

2 participants