Skip to content

Conversation

@gpauloski
Copy link
Collaborator

Description

Previously, D10* lint rules were only excluded on *_test.py files, so package docstrings were required on __init__.py files in test modules. There were also a lot of old test docstrings that just said what the name of the test function said again.

I've removed all of this and updated the ruff configuration to reduce redundant docstrings. In general, the name of the test function should describe its purpose (so the output of pytest -vv is helpful), and any extra details can be included in additional comments as needed but no docstrings are required.

Fixes N/A

Type of Change

  • Breaking Change (fix or enhancement which changes existing semantics of the public interface)
  • Enhancement (new features or improvements to existing functionality)
  • Bug (fixes for a bug or issue)
  • Internal (refactoring, style changes, testing, optimizations)
  • Documentation update (changes to documentation or examples)
  • Package (dependencies, versions, package metadata)
  • Development (CI workflows, pre-commit, linters, templates)
  • Security (security related changes)

Testing

Tests pass.

Pull Request Checklist

Please confirm the PR meets the following requirements.

  • Tags added to PR (e.g., breaking, bug, enhancement, internal, documentation, package, development, security).
  • Code changes pass pre-commit (e.g., mypy, ruff, etc.).
  • Tests have been added to show the fix is effective or that the new feature works.
  • New and existing unit tests pass locally with the changes.
  • Docs have been updated and reviewed if relevant.

@gpauloski gpauloski added the internal Refactoring, style changes, testing, or code optimizations label Jan 29, 2024
@gpauloski gpauloski merged commit 598b260 into main Jan 29, 2024
@gpauloski gpauloski deleted the tests-package-docstrings branch January 29, 2024 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Refactoring, style changes, testing, or code optimizations

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants