Merge pull request #1905 from jenshnielsen/remove_some_doc_types

Remove some doc types

Author: jenshnielsen

qcodes/instrument/channel.py

@@ -92,10 +92,9 @@ class MultiChannelInstrumentParameter(MultiParameter):
     anything else.
 
     Args:
-        channels(list[chan_type]): A list of channels which we can operate on
+        channels: A list of channels which we can operate on
           simultaneously.
-
-        param_name(str): Name of the multichannel parameter
+        param_name: Name of the multichannel parameter
     """
     def __init__(self,
                  channels: Sequence[InstrumentChannel],
@@ -118,7 +117,7 @@ def set_raw(self, value: ParamRawDataType) -> None:
         Set all parameters to this value.
 
         Args:
-            value (Any): The value to set to. The type is given by the
+            value: The value to set to. The type is given by the
                 underlying parameter.
         """
         for chan in self._channels:
@@ -141,24 +140,24 @@ class ChannelList(Metadatable):
     all channels, as well as addressing of individual channels.
 
     Args:
-        parent (Instrument): The instrument to which this channel
+        parent: The instrument to which this channel
             should be attached.
 
-        name (str): The name of the channel list.
+        name: The name of the channel list.
 
-        chan_type (InstrumentChannel): The type of channel contained
+        chan_type: The type of channel contained
             within this list.
 
-        chan_list (Iterable[chan_type]): An optional iterable of
+        chan_list: An optional iterable of
             channels of type ``chan_type``.  This will create a list and
             immediately lock the :class:`ChannelList`.
 
-        snapshotable (bool): Optionally disables taking of snapshots
+        snapshotable: Optionally disables taking of snapshots
             for a given channel list.  This is used when objects
             stored inside a channel list are accessible in multiple
             ways and should not be repeated in an instrument snapshot.
 
-        multichan_paramclass (MultiChannelInstrumentParameter): The class of
+        multichan_paramclass: The class of
             the object to be returned by the ``__getattr__``
             method of :class:`ChannelList`.
             Should be a subclass of :class:`MultiChannelInstrumentParameter`.

qcodes/instrument/visa.py

@@ -35,7 +35,7 @@ class VisaInstrument(Instrument):
             ``pyvisa-py`` backend. Note that QCoDeS does not install (or even require)
             ANY backends, it is up to the user to do that. see eg:
             http://pyvisa.readthedocs.org/en/stable/names.html
-        metadata (Optional[Dict]): additional static metadata to add to this
+        metadata: additional static metadata to add to this
             instrument's JSON snapshot.
 
     See help for :class:`.Instrument` for additional information on writing

qcodes/station.py

@@ -86,12 +86,12 @@ class Station(Metadatable, DelegateAttributes):
     measurement (a list of actions).
 
     Args:
-        *components (list[Any]): components to add immediately to the
+        *components: components to add immediately to the
             Station. Can be added later via ``self.add_component``.
-        monitor (None): Not implemented, the object that monitors the system
-            continuously.
-        default (bool): Is this station the default?
-        update_snapshot (bool): Immediately update the snapshot of each
+        config_file: Path to YAML file to load the station config from.
+        use_monitor: Should the QCoDeS monitor be activated for this station.
+        default: Is this station the default?
+        update_snapshot: Immediately update the snapshot of each
             component as it is added to the Station.
 
     Attributes:

qcodes/utils/validators.py

@@ -941,7 +941,7 @@ def __init__(self, allowed_keys: TSequence[Hashable] = None) -> None:
         Validator for dictionary keys
 
         Args:
-            allowed_keys (List): if set, all keys must be in allowed_keys
+            allowed_keys: if set, all keys must be in allowed_keys
         """
         self.allowed_keys = allowed_keys
         self._valid_values = ({0: 1},)