Add module docstrings to core API and configuration modules #1787
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- dandiapi.py: Document REST API client classes and main functionality - exceptions.py: Document custom exception hierarchy - consts.py: Document constants, metadata fields, and configuration
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1787 +/- ##
==========================================
- Coverage 75.11% 75.10% -0.01%
==========================================
Files 84 84
Lines 11921 11921
==========================================
- Hits 8954 8953 -1
- Misses 2967 2968 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds comprehensive module-level docstrings to core API and configuration modules, improving IDE support and code navigation.
Changes
Benefits
Files Changed
dandi/dandiapi.pydandi/exceptions.pydandi/consts.pyTesting
Verified with full test suite: 548 passed, 0 failed.
See commit: 9ce222b3
Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com