Skip to content

Add module docstrings to operation modules#1788

Merged
CodyCBakerPhD merged 2 commits intomasterfrom
enh-lad-docstrings-operations
Feb 14, 2026
Merged

Add module docstrings to operation modules#1788
CodyCBakerPhD merged 2 commits intomasterfrom
enh-lad-docstrings-operations

Conversation

@yarikoptic-gitmate
Copy link
Collaborator

Adds comprehensive module-level docstrings to operation modules, documenting upload, download, delete, move, and organize functionality.

Changes

  • upload.py: Document upload workflow, validation, and features
  • download.py: Document download functionality, Zarr support, and resume capability
  • delete.py: Document asset deletion operations
  • move.py: Document move/rename functionality
  • organize.py: Document file organization and naming conventions

Benefits

  • Better IDE autocomplete and hover documentation
  • Improved code navigation and understanding
  • Clear documentation of each operation's features and capabilities

Files Changed

  • dandi/upload.py
  • dandi/download.py
  • dandi/delete.py
  • dandi/move.py
  • dandi/organize.py

Testing

Verified with full test suite: 548 passed, 0 failed.

See commit: f2b3affb

Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com

- download.py: Document download functionality and features
- upload.py: Document upload workflow and validation
- delete.py: Document deletion operations
- move.py: Document move/rename functionality
- organize.py: Document file organization and naming
@yarikoptic-gitmate yarikoptic-gitmate added the documentation Changes only affect the documentation label Feb 12, 2026
@codecov
Copy link

codecov bot commented Feb 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.12%. Comparing base (830debb) to head (149feff).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1788   +/-   ##
=======================================
  Coverage   75.11%   75.12%           
=======================================
  Files          84       84           
  Lines       11922    11922           
=======================================
+ Hits         8955     8956    +1     
+ Misses       2967     2966    -1     
Flag Coverage Δ
unittests 75.12% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.

@CodyCBakerPhD
Copy link
Contributor

Always nice when querying [module name]? to see something other than <no docstring>

@CodyCBakerPhD CodyCBakerPhD merged commit 0a09670 into master Feb 14, 2026
36 of 37 checks passed
@CodyCBakerPhD CodyCBakerPhD deleted the enh-lad-docstrings-operations branch February 14, 2026 04:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes only affect the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants