Skip to content

Create documentation for dynamically created methods

Rohit Navarathna requested to merge indent_partial_function_documentation into development

Description

This MR works in conjunction with https://gitlab.com/qblox/packages/software/qblox_instruments_docs/-/merge_requests/235, but doesn't depend on it.

  1. Dynamically created methods are documented in a similar way to Qcodes parameters.
  2. Partial functions are also documented.
    1. The previously used note about partial functions is converted to numpydoc format.
    2. The relevant parameter is removed from the docstring
  3. Copy docstring decorator now has the option of adding a parameter.
    1. Many functions in cluster.py that used the decorator now add a slot parameter.

Here is a before and after for a cluster method where the slot parameter is added: image

Here is a before and after for a cluster sequencer partial method, which is derived from a cluster module partial method, which is derived from a cluster method. image

Type

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Issue(s)

Related MRs

https://gitlab.com/qblox/packages/software/qblox_instruments_docs/-/merge_requests/235

Testing

Notes

Merge checklist

  • Cleaned up code (correct alligment/spacing/code-style, no dead code, etc).
  • Merge request targets development branch.
  • Assigned assignee (you) and reviewers (team-members).
  • Merge request has been reviewed by at least one team-members.
  • All pipelines pass, including manually triggered ones.
Edited by Edmundo Ferreira

Merge request reports