Skip to content

Enable ruff D102 and D105 linting rules - #486

Merged
gmartinon-ed merged 1 commit into
mainfrom
chore/ruff-d102-d105
Oct 22, 2026
Merged

gmartinon-ed merged 1 commit into
mainfrom
chore/ruff-d102-d105

Conversation

@gmartinon-ed

Copy link
Copy Markdown
Collaborator

Description

  • Enables the ruff D102 (missing docstring in public method) and D105 (missing docstring in magic method) rules in pyproject.toml.
  • Adds the missing docstrings: public properties of the inference and monitoring result classes, __str__ / __repr__ / __post_init__ of those classes, and the confidence_level getter of the confidence intervals.
  • Renames the MeanEstimationEngine methods (preprocess, fit_tuning_parameter, compute_mean_and_std) to _preprocess, _fit_tuning_parameter and _compute_mean_and_std across the engines and their callers (estimators, monitors, tests). The engines are internal, so the leading underscore exempts them from D102 instead of requiring redundant docstrings or per-file ignores.
  • Part of the "Continuous linting refactors - D102 / D105" ticket.

Checklist

Quality gates that must be satisfied before requesting a review:

  • I have read CONTRIBUTING.md
  • make lint passes
  • make type-check passes
  • make tests passes
  • make coverage reports 100% coverage
  • make test-notebooks passes
  • New public API has numpy-style docstrings
  • New public API is inserted in the API reference section of the documentation
  • Docs build without warnings (make doc)
  • CHANGELOG.md updated if the change is user-facing

LLM usage

Disclose if an LLM was used in writing this PR:

  • No LLM used
  • I used an LLM and I went through and validated all the code myself

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@gmartinon-ed gmartinon-ed added refactoring Improve structure with no functional change repository Change in the repository files (CI, markdowns, etc.) labels Oct 22, 2026
@gmartinon-ed
gmartinon-ed requested a review from imerad October 22, 2026 12:20
@codecov

codecov Bot commented Oct 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@gmartinon-ed
gmartinon-ed merged commit 5e8e343 into main Oct 22, 2026
6 checks passed
@gmartinon-ed
gmartinon-ed deleted the chore/ruff-d102-d105 branch October 22, 2026 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

refactoring Improve structure with no functional change repository Change in the repository files (CI, markdowns, etc.)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants