microsoft / microsoft/Qcodes

Unify default values of arguments for all snapshot_base and snapshot methods in qcodes repo

Open
#4,808 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
459
Forks
359
Avg merge
3d 6h
Merged PRs (30d)
73

Description

To promote "the same" behaviour unless needed explicitly.

For example, the `ZIHDAWG8` driver - does anyone know why is this override needed? how is this instrument special to all the other instruments? (this code snippet is not from the latest main branch, but similar ones can be found in the repo)
https://github.com/QCoDeS/Qcodes/blob/295ad9043ba52d61432b4e73ab1a39714572bb0c/qcodes/instrument_drivers/ZI/ZIHDAWG8.py#L79-L81

Also, look at Parameter/Instrument/Channel/Station if there's consistency.

This is created as a substitute for #1830.

Contributor guide

Open the contributing guide

Research direction

Start by locating the snapshot_base and snapshot methods across Parameter, Instrument, Channel, and Station, then inspect the ZIHDAWG8.py override around lines 79–81. Compare their default arguments and determine which inconsistencies are intentional. Done means the defaults are unified where appropriate and instrument-specific overrides have a documented reason or are removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.