Merged
Conversation
This commit includes fixes for a subset of pydocstyle `D` rule violations, primarily focusing on: - D401: Ensuring the first line of docstrings is in the imperative mood. - D100/D102/D104/D107: Adding missing docstrings for modules, methods, packages, and __init__ methods. - D205: Ensuring one blank line between summary and description. - D301: Using raw string literals for docstrings with backslashes. - D417: Adding missing argument descriptions. - D418: Addressed by ensuring overloads have docstrings as per specific prompt instructions. Files addressed so far include: - docs/conf.py - tsercom/__init__.py - Various files under tsercom/api/ - Various files under tsercom/caller_id/ - Various files under tsercom/data/ Further work is pending to address all remaining `D` rule violations across the codebase. Static analysis: - `black .` passes. - `mypy tsercom/` has pre-existing errors; no new errors were introduced by these changes. Unused `type: ignore` comments were removed. - `ruff check . --select D` will be fully addressed in subsequent commits. Testing: - `pytest --timeout=120` (run via `PYTEST_TIMEOUT=120 python -m pytest`) passed twice with 970 tests passing, 11 skipped, and 13 warnings. No new test failures were introduced.
This commit includes additional fixes for pydocstyle D-rules across various files in the tsercom codebase. Fixes primarily address: - D205: Blank line issues in module and class docstrings. - D401: Ensuring first line of docstrings is in imperative mood. - D10x: Adding missing docstrings (modules, methods, __init__). - D413: Ensuring blank line after Args section. - D207: Correcting docstring indentation. - Syntax errors identified during linting. D418 (overload docstrings) were handled by ensuring each @overload has its own docstring as per explicit prompt requirements. Main implementation docstrings for overloaded methods were minimized. Remaining D418 violations on @overload lines themselves are considered 'won't fix' due to conflict with these requirements. All tests are passing (970 passed, 11 skipped, 13 warnings), consistent with the previous state before these D-rule fixes.
This commit includes further fixes for pydocstyle D-rules, continuing the effort to bring all docstrings into compliance. Key changes: - Added D104 package docstrings (e.g., for tsercom/tensor/serialization). - Corrected D401 (imperative mood) for various methods. - Fixed D205 (summary line formatting) for classes and methods. - Addressed D100 (module), D107 (__init__), D102 (public method), D105 (magic method), and D413 (blank line after section) where found. - Suppressed D418 globally in pyproject.toml as per user instruction, due to conflict with the requirement to document all overloads. - Resolved syntax errors inadvertently introduced during prior edits. All tests continue to pass (970 passed, 11 skipped, 13 warnings), consistent with the previous state. E501 line length errors are still deferred.
This commit includes pydocstyle D-rule fixes made so far. Due to persistent errors with the `run_in_bash_session` tool failing for `ruff check` and `black .` (reporting that these commands modify too many files), full static analysis and verification of recent changes could not be completed. This PR is submitted in the current state at user request. Key changes included prior to tool issues: - Added/fixed numerous D10x, D20x, D30x, D40x docstring issues. - Suppressed D418 globally in pyproject.toml as per user instruction. - Addressed syntax errors.
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
1 participant
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 includes fixes for a subset of pydocstyle
Drule violations, primarily focusing on:Files addressed so far include:
Further work is pending to address all remaining
Drule violations across the codebase.Static analysis:
black .passes.mypy tsercom/has pre-existing errors; no new errors were introduced by these changes. Unusedtype: ignorecomments were removed.ruff check . --select Dwill be fully addressed in subsequent commits.Testing:
pytest --timeout=120(run viaPYTEST_TIMEOUT=120 python -m pytest) passed twice with 970 tests passing, 11 skipped, and 13 warnings. No new test failures were introduced.