Merge pull request #1788 from dandi/enh-lad-docstrings-operations

Add module docstrings to operation modules

Author: CodyCBakerPhD

dandi/delete.py

@@ -1,3 +1,13 @@
+"""Delete assets and dandisets from DANDI Archive.
+
+This module provides functionality for deleting assets and entire dandisets
+from DANDI Archive instances. It supports:
+- Single and batch asset deletion
+- Dandiset deletion with confirmation
+- URL-based and path-based deletion
+- Skip-missing option for non-existent resources
+"""
+
 from __future__ import annotations
 
 from collections.abc import Iterable, Iterator

dandi/download.py

@@ -1,3 +1,13 @@
+"""Download assets from DANDI Archive.
+
+This module provides functionality for downloading files and Zarr archives
+from DANDI Archive instances. It supports:
+- Individual file downloads with integrity verification
+- Zarr archive downloads with parallel entry handling
+- Resume capability for interrupted downloads
+- Progress tracking and error recovery
+"""
+
 from __future__ import annotations
 
 from collections import Counter, deque

dandi/move.py

@@ -1,3 +1,14 @@
+"""Move and rename assets in DANDI Archive.
+
+This module provides functionality for moving and renaming assets both
+locally and remotely in DANDI Archive instances. Features include:
+- Local file reorganization
+- Remote asset path changes
+- Combined local and remote moves
+- Conflict resolution (skip, overwrite, error)
+- Validation of move operations
+"""
+
 from __future__ import annotations
 
 from abc import ABC, abstractmethod

dandi/organize.py

@@ -1,5 +1,12 @@
-"""
-ATM primarily a sandbox for some functionality for dandi organize
+"""Organize and structure NWB files according to DANDI conventions.
+
+This module provides functionality for organizing neuroscience data files
+according to DANDI's file organization schema. Features include:
+- Automatic path generation from metadata
+- BIDS-like subject/session organization
+- Metadata-driven file naming
+- Validation of organized paths
+- Support for videos and generic files
 """
 
 from __future__ import annotations

dandi/upload.py

@@ -1,3 +1,14 @@
+"""Upload assets to DANDI Archive.
+
+This module handles uploading NWB files and other assets to DANDI Archive
+instances. Features include:
+- Validation of files before upload
+- Progress tracking with resume capability
+- Metadata extraction and assignment
+- BIDS validation integration
+- Concurrent uploads with thread pool
+"""
+
 from __future__ import annotations
 
 from collections import defaultdict