Skip to content

Commit 2065480

Browse files
jenshnielsenCopilot
andcommitted
Remove forwarded kwargs docs from Parameter class docstring
Remove documentation for instrument, max_val_age, vals, and bind_to_instrument from the Parameter class docstring since these are not explicit parameters but are forwarded via **kwargs to ParameterBase. The **kwargs entry already references ParameterBaseKWArgs for details. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent a155e42 commit 2065480

1 file changed

Lines changed: 0 additions & 14 deletions

File tree

src/qcodes/parameters/parameter.py

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -249,9 +249,6 @@ class Parameter(
249249
referenced from that parent, ie ``instrument.name`` or
250250
``instrument.parameters[name]``.
251251
252-
instrument: The instrument this parameter
253-
belongs to, if any.
254-
255252
label: Normally used as the axis label when this
256253
parameter is graphed, along with ``unit``.
257254
@@ -272,14 +269,6 @@ class Parameter(
272269
``parameter.set(initial_value)`` after parameter initialization).
273270
Cannot be passed together with ``initial_cache_value`` argument.
274271
275-
max_val_age: The max time (in seconds) to trust a
276-
saved value obtained from ``cache()`` (or ``cache.get()``, or
277-
``get_latest()``. If this parameter has not been set or measured
278-
more recently than this, perform an additional measurement.
279-
280-
vals: Allowed values for setting this parameter.
281-
Only relevant if settable. Defaults to ``Numbers()``.
282-
283272
docstring: Documentation string for the ``__doc__``
284273
field of the object. The ``__doc__`` field of the instance is
285274
used by some help systems, but not all.
@@ -290,9 +279,6 @@ class Parameter(
290279
initialization). Cannot be passed together with ``initial_value``
291280
argument.
292281
293-
bind_to_instrument: Should the parameter be registered as a delegate
294-
attribute on the instrument passed via the instrument argument.
295-
296282
**kwargs: Forwarded to the ``ParameterBase`` base class.
297283
See :class:`ParameterBaseKWArgs` for details.
298284

0 commit comments

Comments
 (0)