docs: Convert Sphinx-style docstrings to NumPy-style#1378
Merged
dimitri-yatsenko merged 1 commit intopre/v2.1from Feb 3, 2026
Merged
docs: Convert Sphinx-style docstrings to NumPy-style#1378dimitri-yatsenko merged 1 commit intopre/v2.1from
dimitri-yatsenko merged 1 commit intopre/v2.1from
Conversation
Convert all :param/:return:/:raises: docstrings to NumPy-style format as specified in CONTRIBUTING.md. This ensures proper rendering in API documentation generated by mkdocstrings. Files updated: - expression.py: 28 methods converted - table.py: 24 methods/functions converted - heading.py: 2 methods converted - utils.py: 8 functions converted Also removes unused parse_sql() function. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
f82a333 to
c999b5f
Compare
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
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.
Summary
Convert all Sphinx-style docstrings (
:param,:return:,:raises:) to NumPy-style format as specified in CONTRIBUTING.md.This ensures proper rendering in API documentation generated by mkdocstrings (which is configured for
docstring_style: numpy).Files Updated
expression.pytable.pyheading.pyutils.pyExample Conversion
Before (Sphinx-style):
After (NumPy-style):
🤖 Generated with Claude Code