Skip to content

Conversation

@Kyung-hoon-Jung0
Copy link
Collaborator

Summary

This PR focuses solely on pre-commit (pylint/black) compliance for newly added calibration files.

  • No functional or behavioral changes
  • Only docstrings, minor typo/formatting fixes, and explicit pylint rule handling
  • Goal: ensure clean pre-commit passes and reduce reviewer burden

Reviewer note

GitHub shows all lines as changed because these files are newly added to the KAVR_12182025 branch.  
To avoid a full line-by-line review, the changes below are organized by file, summarizing all intentional, non-functional modifications.


File-by-file summary of changes (non-functional only)

03b_qubit_spectroscopy_vs_flux.py

  • Added module docstring
  • Fixed long docstrings:
      - Split lines exceeding max length (lines 181, 221)
  • Added missing docstrings for:
      - custom_param (line 56)
      - save_results (line 267)
  • Added # pylint: disable=too-many-locals (line 69)
      - Required due to QUA program structure and is intentional
  • Changed list comprehension to generator expression (line 77)
      - Changed any([q.z is None for q in qubits]) to any(q.z is None for q in qubits)
  • Removed unnecessary else after continue (line 252)
      - Simplified control flow

calibration_utils/qubit_spectroscopy_vs_flux/__init__.py

  • Added module docstring

calibration_utils/qubit_spectroscopy_vs_flux/analysis.py

  • Added module docstring
  • Fixed long docstring:
      - Split line exceeding max length (line 52)
  • Added # pylint: disable=invalid-name for m_pH variable and attribute
      - Preserves physics notation convention (mutual inductance in pH)
  • Replaced __bool__() with bool() (line 143)

calibration_utils/qubit_spectroscopy_vs_flux/parameters.py

  • Added module docstring
  • Added class docstrings for:
      - NodeSpecificParameters
      - Parameters
  • Added # pylint: disable=too-many-ancestors for Parameters
      - Follows internal rules: the class intentionally composes multiple mixins by design

calibration_utils/qubit_spectroscopy_vs_flux/plotting.py

  • Added module docstring

Notes

  • All files now pass the project's pylint checks via pre-commit
  • The remaining local-module import warning (quam_config) is expected and already explicitly disabled
  • No logic, algorithm, or runtime behavior was modified

@Kyung-hoon-Jung0
Copy link
Collaborator Author

Superseded by #27
This PR was created before the baseline import and new pre-commit rules.
A clean PR has been opened from the updated KAVR_12182025.

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.

2 participants