Merge pull request #1787 from dandi/enh-lad-docstrings-core

Add module docstrings to core API and configuration modules

Author: CodyCBakerPhD

dandi/consts.py

@@ -1,3 +1,12 @@
+"""Constants and configuration for DANDI CLI.
+
+This module defines constants used throughout the DANDI CLI including:
+- Metadata field definitions for NWB files
+- Known DANDI Archive instances and their configurations
+- File organization patterns and BIDS-related constants
+- Request timeouts and retry settings
+"""
+
 from __future__ import annotations
 
 from collections.abc import Iterator

dandi/dandiapi.py

@@ -1,3 +1,15 @@
+"""REST API client for interacting with DANDI Archive instances.
+
+This module provides client classes for communicating with DANDI Archive API
+servers, including asset management, dandiset operations, and authentication.
+
+The main classes are:
+- DandiAPIClient: High-level client for DANDI API operations
+- RESTFullAPIClient: Base HTTP client with retry and authentication
+- RemoteDandiset: Represents a dandiset on the server
+- RemoteAsset: Represents an asset (file) on the server
+"""
+
 from __future__ import annotations
 
 from abc import ABC, abstractmethod

dandi/exceptions.py

@@ -1,3 +1,10 @@
+"""Custom exceptions for DANDI CLI operations.
+
+This module defines exception classes used throughout the DANDI CLI for
+handling various error conditions including network errors, validation
+failures, and version incompatibilities.
+"""
+
 from __future__ import annotations
 
 import requests