Code organization and documentation#1296
Closed
dimitri-yatsenko wants to merge 2 commits intoclaude/refine-primary-key-rules-lVgTtfrom
Closed
Code organization and documentation#1296dimitri-yatsenko wants to merge 2 commits intoclaude/refine-primary-key-rules-lVgTtfrom
dimitri-yatsenko wants to merge 2 commits intoclaude/refine-primary-key-rules-lVgTtfrom
Conversation
…cstrings This commit improves the overall code organization of the datajoint package: 1. Added `from __future__ import annotations` to all Python modules for consistent PEP 563 deferred annotation evaluation 2. Added comprehensive module-level docstrings to all files explaining the purpose and functionality of each module 3. Added modern Python 3.10+ type hints to core API methods: - expression.py: QueryExpression properties and query operators - table.py: Table CRUD operations (insert, delete, etc.) - fetch.py: Fetch and Fetch1 classes 4. Standardized import organization across all modules with: - Future annotations import at the top - Standard library imports - Third-party imports - Local imports 5. Replaced legacy Union[X, Y] syntax with modern X | Y union syntax 6. Improved docstrings for critical public methods with parameter and return type documentation 7. Removed unused imports flagged by flake8 Co-authored-by: dimitri-yatsenko <dimitri@datajoint.com>
dimitri-yatsenko
force-pushed
the
claude/review-code-organization-2d7GO
branch
from
59868f9 to
de03e6e
Compare
…ew-code-organization-2d7GO Merge code organization improvements (docstrings, type hints, future annotations) with semantic matching and primary key refinement features. Resolved conflicts: - src/datajoint/expression.py: merged docstrings - src/datajoint/s3.py: merged deprecation notice with improved docstring - src/datajoint/table.py: kept type hints and added _populate_lineage method Co-authored-by: dimitri-yatsenko <dimitri@datajoint.com>
Member
Author
|
There was a mixup in branching structure. |
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
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.
This commit improves the overall code organization of the datajoint package:
Added
from __future__ import annotationsto all Python modules for consistent PEP 563 deferred annotation evaluationAdded comprehensive module-level docstrings to all files explaining the purpose and functionality of each module
Added modern Python 3.10+ type hints to core API methods:
Standardized import organization across all modules with:
Replaced legacy Union[X, Y] syntax with modern X | Y union syntax
Improved docstrings for critical public methods with parameter and return type documentation