Skip to content

Conversation

@paulQM
Copy link
Collaborator

@paulQM paulQM commented Jan 12, 2026

PR Summary: Fix pylint errors for CZ phase compensation

Overview

This PR fixes all pylint errors in the CZ phase compensation calibration module to ensure pre-commit compliance. The changes improve code quality by adding missing documentation and fixing import ordering issues.

Branch

chore/styx-precommit-cz-phase-compensation

Changes Made

1. Import Ordering Fix

File: calibrations/CZ_calibration_fixed_couplers/21_cz_phase_compensation.py

  • Fixed import ordering to comply with PEP 8 standards
  • Moved first-party import (calibration_utils.cz_phase_compensation) to after all third-party imports
  • Pylint score improved from 9.21/10 to 10.00/10

2. Documentation Additions

Files Modified:

  • calibration_utils/cz_phase_compensation/__init__.py
  • calibration_utils/cz_phase_compensation/analysis.py
  • calibration_utils/cz_phase_compensation/parameters.py
  • calibration_utils/cz_phase_compensation/plotting.py

Changes:

  • Added module docstrings to all files in the cz_phase_compensation package
  • Added function docstrings for:
    • process_raw_dataset() in analysis.py
    • fit_routine() in analysis.py
  • Added class docstring for Parameters class in parameters.py
  • Pylint score improved from 9.41/10 to 10.00/10 for the entire module

Files Changed

  • calibrations/CZ_calibration_fixed_couplers/21_cz_phase_compensation.py
  • calibration_utils/cz_phase_compensation/__init__.py
  • calibration_utils/cz_phase_compensation/analysis.py
  • calibration_utils/cz_phase_compensation/parameters.py
  • calibration_utils/cz_phase_compensation/plotting.py

Testing

  • All files now pass pylint with a score of 10.00/10
  • No functional changes were made; only code quality improvements

Impact

  • ✅ All pylint errors resolved
  • ✅ Code now compliant with pre-commit hooks
  • ✅ Improved code documentation and maintainability
  • ✅ No breaking changes

@paulQM paulQM merged commit 448bc47 into KAVR_12182025 Jan 13, 2026
3 of 6 checks passed
@paulQM paulQM deleted the chore/styx-precommit-cz-phase-compensation branch January 13, 2026 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants