Documentation: Strip docstrings from __init__ functions
Explanation of changes
__init__
docstrings has been merged with class docstrings, __init__
got removed completely.
Eventually I also rephrased docstrings to the
"""
Single-line short description
Multi-line
long
decsription.
"""
format.
Motivation of changes
__init__
docstring is usually trivial and redundant, and we want to disable it altogether while generating the documentation. This way usually leads to a better rendering.
To do
-
backends
-
├── qblox
-
│ ├── operation_handling
-
│ │ ├── acquisitions.py
-
│ │ ├── base.py
-
│ │ ├── factory.py
-
│ │ ├── pulses.py
-
│ │ └── virtual.py
-
│ ├── compiler_abc.py
-
│ ├── compiler_container.py
-
│ ├── constants.py
-
│ ├── driver_version_check.py
-
│ ├── enums.py
-
│ ├── helpers.py
-
│ ├── instrument_compilers.py
-
│ ├── q1asm_instructions.py
-
│ ├── qasm_program.py
-
│ └── register_manager.py
-
├── types
-
│ ├── common.py
-
│ ├── qblox.py
-
│ └── zhinst.py
-
├── zhinst
-
│ ├── helpers.py
-
│ ├── resolvers.py
-
│ ├── seqc_il_generator.py
-
│ └── settings.py
-
├── circuit_to_device.py
-
├── corrections.py
-
├── graph_compilation.py
-
├── qblox_backend.py
-
└── zhinst_backend.py
-
device_under_test
-
├── composite_square_edge.py
-
├── device_element.py
-
├── edge.py
-
├── mock_setup.py
-
├── nv_element.py
-
├── quantum_device.py
-
└── transmon_element.py
-
helpers
-
├── collections.py
-
├── diagnostics_report.py
-
├── importers.py
-
├── inspect.py
-
├── mock_instruments.py
-
├── schedule.py
-
├── time.py
-
├── validators.py
-
└── waveforms.py
-
instrument_coordinator
-
├── components
-
│ ├── base.py
-
│ ├── generic.py
-
│ ├── qblox.py
-
│ └── zhinst.py
-
├── instrument_coordinator.py
-
└── utility.py
-
operations
-
├── acquisition_library.py
-
├── gate_library.py
-
├── measurement_factories.py
-
├── nv_native_library.py
-
├── operation.py
-
├── pulse_factories.py
-
├── pulse_library.py
-
├── shared_native_library.py
-
└── stitched_pulse.py
-
schedules
-
├── _visualization
-
│ ├── circuit_diagram.py
-
│ ├── constants.py
-
│ ├── pulse_diagram.py
-
│ └── pulse_scheme.py
-
├── schedule.py
-
├── spectroscopy_schedules.py
-
├── timedomain_schedules.py
-
├── trace_schedules.py
-
└── verification.py
-
schemas
-
├── examples
-
│ ├── device_example_cfgs.py
-
│ ├── qblox_hardware_compilation_config.json
-
│ ├── qblox_test_mapping_nv_centers.json
-
│ ├── utils.py
-
│ └── zhinst_hardware_compilation_config.json
-
├── operation.json
-
├── resource.json
-
├── schedulable.json
-
└── schedule.json
-
structure
-
├── model.py
-
└── types.py
-
_static_version.py
-
_version.py
-
compilation.py
-
enums.py
-
frontends.py
-
gettables.py
-
gettables_profiled.py
-
json_utils.py
-
math.py
-
resources.py
-
types.py
-
waveforms.py
Merge checklist
See also merge request guidelines
-
Merge request has been reviewed (in-depth by a knowledgeable contributor), and is approved by a project maintainer. -
New code is covered by unit tests (or N/A). -
New code is documented and docstrings use numpydoc format (or N/A). -
New functionality: considered making private instead of extending public API (or N/A). -
Public API changed: added @deprecated
(or N/A). -
Pipeline fix or dependency update: post in #software-for-developers
channel to mergemain
back in or update local packages (or N/A). -
Tested on hardware (or N/A). -
CHANGELOG.md
andAUTHORS.md
have been updated (or N/A). -
Windows tests in CI pipeline pass (manually triggered by maintainers before merging). - Maintainers do not hit Auto-merge, we need to actively check as manual tests do not block pipeline
For reference, the issues workflow is described in the contribution guidelines.
Edited by Viacheslav Ostroukh